Add Multi Org Support Section for GitHub Ocean #2885
+335
−19
Conversation
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 pull request is automatically being deployed by Amplify Hosting (learn more). |
mk-armah
reviewed
Oct 14, 2025
Comment on lines
37
to
38
| - **With classic PAT**: Specify a list of organizations: `githubOrganizations: ["org1", "org2", "org3"]` | ||
| - **With classic PAT**: Leave empty to sync all organizations the PAT user is a member of: `githubOrganizations: []` |
kodjomiles
requested changes
Oct 14, 2025
Comment on lines
33
to
55
| :::warning Breaking change in v2.0.0-beta | ||
| The configuration parameter has changed from `githubOrganization` (singular) to `githubOrganizations` (plural, array format). You must update your configuration when upgrading to v2.0.0-beta. | ||
|
|
||
| **Before:** | ||
| ```yaml | ||
| githubOrganization: "my-org" | ||
| ``` | ||
| **After (v2.0.0-beta):** | ||
| ```yaml | ||
| githubOrganizations: ["my-org"] # Now an array | ||
| ``` | ||
| ::: | ||
| :::info Authentication requirements | ||
| - **Classic PAT**: Supports multiple organizations | ||
| - **Fine-grained PAT**: Does NOT support multi-organization | ||
| - **GitHub App**: Supports exactly **one organization** only | ||
| ::: | ||
| :::caution Performance impact | ||
| Syncing multiple organizations increases API calls and may slow down the integration. Consider syncing only the organizations you need. | ||
| ::: |
There was a problem hiding this comment.
We don't use two or more admonitions in a row
There was a problem hiding this comment.
Find another way to communicate this
Comment on lines
27
to
34
| :::info Authentication requirements | ||
| - **Classic PAT**: Supports multiple organizations. Fine-grained PAT tokens do not support multi-organization authentication. | ||
| - **GitHub App**: Only supports a **single organization** (minimum 1, maximum 1). You must specify exactly one organization in the `githubOrganizations` array. | ||
| ::: | ||
|
|
||
| :::caution Performance impact | ||
| Syncing multiple organizations will increase the number of API calls to GitHub and may slow down the integration. The more organizations you sync, the longer the resync time and the higher the API rate limit consumption. Consider syncing only the organizations you need. | ||
| ::: |
There was a problem hiding this comment.
Same comment about the admonition
Comment on lines
25
to
32
| :::warning Authentication limitations | ||
| - **Classic PAT**: Supports multiple organizations. Fine-grained PAT tokens do not support multi-organization authentication. | ||
| - **GitHub App**: Only supports a **single organization** (minimum 1, maximum 1). You must specify exactly one organization in the `githubOrganizations` array. | ||
| ::: | ||
|
|
||
| :::caution Performance impact | ||
| Syncing multiple organizations will increase the number of API calls to GitHub and may slow down the integration. The more organizations you sync, the longer the resync time and the higher the API rate limit consumption. Consider syncing only the organizations you need. | ||
| ::: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
Added docs pages
Please also include the path for the added docs
/)/platform-overview/port-components/blueprint)Updated docs pages
Please also include the path for the updated docs
/)/platform-overview/port-components/blueprint)