-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Remove Enterprise Management Console client and related code #1764
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
dob9601
wants to merge
2
commits into
octokit:main
Choose a base branch
from
dob9601:dob9601/remove-deprecated-mgmt-console-client
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,7 +32,7 @@ Upgrading? Check the [Upgrade Guide](#upgrading-guide) before bumping to a new | |
10. [Working with GitHub Enterprise](#working-with-github-enterprise) | ||
1. [Interacting with the GitHub.com APIs in GitHub Enterprise](#interacting-with-the-githubcom-apis-in-github-enterprise) | ||
2. [Interacting with the GitHub Enterprise Admin APIs](#interacting-with-the-github-enterprise-admin-apis) | ||
3. [Interacting with the GitHub Enterprise Management Console APIs](#interacting-with-the-github-enterprise-management-console-apis) | ||
3. [Interacting with the GHES Manage API](#interacting-with-the-ghes-manage-api) | ||
4. [SSL Connection Errors](#ssl-connection-errors) | ||
11. [Configuration and defaults](#configuration-and-defaults) | ||
1. [Configuring module defaults](#configuring-module-defaults) | ||
|
@@ -160,7 +160,7 @@ When the API returns an error response, Octokit will raise a Ruby exception. | |
A range of different exceptions can be raised depending on the error returned | ||
by the API - for example: | ||
|
||
* A `400 Bad Request` response will lead to an `Octokit::BadRequest` error | ||
* A `400 Bad Request` response will lead to an `Octokit::BadRequest` error | ||
* A `403 Forbidden` error with a "rate limited exceeded" message will lead | ||
to a `Octokit::TooManyRequests` error | ||
|
||
|
@@ -369,26 +369,30 @@ Octokit.configure do |c| | |
c.access_token = "<your 40 char token>" | ||
end | ||
|
||
admin_client = Octokit.enterprise_admin_client.new | ||
admin_client = Octokit.enterprise_admin_client | ||
``` | ||
|
||
### Interacting with the GitHub Enterprise Management Console APIs | ||
### Interacting with the GHES (GitHub Enterprise Server) Manage API | ||
|
||
The GitHub Enterprise Management Console APIs are also under a separate client: `EnterpriseManagementConsoleClient`. In order to use it, you'll need to provide both your management console password as well as the endpoint to your management console. This is different from the API endpoint provided above. | ||
The GHES Manage API is also under a separate client: `ManageGHESClient`. In order to use it, you'll need to provide your username and password, along with the endpoint to your ghes instance. This is different from the API endpoint provided above. | ||
|
||
If you do not provide a username, the root site administrator account will be used. | ||
|
||
```ruby | ||
management_console_client = Octokit::EnterpriseManagementConsoleClient.new( | ||
:management_console_password => "secret", | ||
:management_console_endpoint = "https://hostname:8633" | ||
ghes_client = Octokit::ManageGHESClient.new( | ||
:manage_ghes_endpoint = "https://hostname:8443" | ||
:manage_ghes_username => "username", | ||
:manage_ghes_password => "password", | ||
) | ||
|
||
# or | ||
Octokit.configure do |c| | ||
c.management_console_endpoint = "https://hostname:8633" | ||
c.management_console_password = "secret" | ||
c.manage_ghes_endpoint = "https://hostname:8443" | ||
c.manage_ghes_username => "username" | ||
c.manage_ghes_password => "password" | ||
end | ||
|
||
management_console_client = Octokit.enterprise_management_console_client.new | ||
ghes_client = Octokit.manage_ghes_client | ||
``` | ||
|
||
### SSL Connection Errors | ||
|
@@ -532,7 +536,11 @@ construction currently used throughout the client. | |
|
||
## Upgrading guide | ||
|
||
Version 4.0 | ||
### Management Console API Removal | ||
|
||
[In GHES 3.15, the management console API was removed](https://docs.github.com/en/[email protected]/admin/release-notes#3.15.0-retired). If you have any tooling that is using this API, you should transition to using the [Manage GHES API](#interacting-with-the-ghes-manage-api) instead. | ||
|
||
### Version 4.0 | ||
|
||
- **removes support for a [long-deprecated overload][list-pulls] for | ||
passing state as a positional argument** when listing pull requests. Instead, | ||
|
@@ -706,9 +714,7 @@ Octokit: | |
| `OCTOKIT_TEST_GITHUB_ORGANIZATION` | Test organization. | | ||
| `OCTOKIT_TEST_GITHUB_ENTERPRISE_LOGIN` | GitHub Enterprise login name. | | ||
| `OCTOKIT_TEST_GITHUB_ENTERPRISE_TOKEN` | GitHub Enterprise token. | | ||
| `OCTOKIT_TEST_GITHUB_ENTERPRISE_MANAGEMENT_CONSOLE_PASSWORD` | GitHub Enterprise management console password. | | ||
| `OCTOKIT_TEST_GITHUB_ENTERPRISE_ENDPOINT` | GitHub Enterprise hostname. | | ||
| `OCTOKIT_TEST_GITHUB_ENTERPRISE_MANAGEMENT_CONSOLE_ENDPOINT` | GitHub Enterprise Management Console endpoint. | | ||
| `OCTOKIT_TEST_GITHUB_MANAGE_GHES_ENDPOINT` | GitHub Enterprise Server GHES Manage Endpoint. | | ||
| `OCTOKIT_TEST_GITHUB_MANAGE_GHES_USERNAME` | GitHub Enterprise Server GHES Manage Username. | | ||
| `OCTOKIT_TEST_GITHUB_MANAGE_GHES_PASSWORD` | GitHub Enterprise Server GHES Manage Password. | | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.