-
Notifications
You must be signed in to change notification settings - Fork 4.2k
fix(amplify-alpha): clarify GitHub repository configuration #34139
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
Closed
Closed
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
833a0cb
fix(aws-amplify-alpha): clarify GitHub repository configuration to ad…
Jay2113 bd47ebc
Merge branch 'main' into fix/amplify-alpha-github
Jay2113 0b9e11b
update repo comment
Jay2113 672fc04
Merge branch 'main' into fix/amplify-alpha-github
Jay2113 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 |
---|---|---|
|
@@ -26,29 +26,42 @@ export interface IApp extends IResource { | |
*/ | ||
export interface SourceCodeProviderConfig { | ||
/** | ||
* The repository for the application. Must use the `HTTPS` protocol. | ||
* The full HTTPS URL for the repository for the application. | ||
* | ||
* For example, `https://github.com/aws/aws-cdk`. | ||
* For GitHub: `https://github.com/owner/repository` | ||
* For GitLab: `https://gitlab.com/owner/repository` | ||
* For CodeCommit: The HTTPS clone URL | ||
*/ | ||
readonly repository: string; | ||
|
||
/** | ||
* OAuth token for 3rd party source control system for an Amplify App, used | ||
* to create webhook and read-only deploy key. OAuth token is not stored. | ||
* | ||
* Either `accessToken` or `oauthToken` must be specified if `repository` | ||
* is specified. | ||
* For GitHub repositories, use `accessToken` instead. OAuth tokens for GitHub repositories | ||
* are supported for backward compatibility but we strongly recommend using `accessToken` | ||
* with the Amplify GitHub App. | ||
* | ||
* For other repository providers like Bitbucket or CodeCommit, use `oauthToken`. | ||
* | ||
* Either `accessToken` (GitHub) or `oauthToken` (other providers) must be specified | ||
* when connecting to a source code repository. | ||
* | ||
* @default - do not use a token | ||
* @deprecated For GitHub repositories, use accessToken instead | ||
*/ | ||
readonly oauthToken?: SecretValue; | ||
|
||
/** | ||
* Personal Access token for 3rd party source control system for an Amplify | ||
* App, used to create webhook and read-only deploy key. Token is not stored. | ||
* Personal Access token for GitHub repository for an Amplify | ||
* App, used to authorize access to a GitHub repository using the Amplify GitHub App. | ||
* Token is not stored. | ||
* | ||
* This is the recommended way to authorize access to GitHub repositories. | ||
* For non-GitHub repositories (GitLab, Bitbucket, CodeCommit), use `oauthToken`. | ||
* | ||
* Either `accessToken` or `oauthToken` must be specified if `repository` | ||
* is sepcified. | ||
* Either `accessToken` (GitHub) or `oauthToken` (other providers) must be specified | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should there be a validation to assert this assumption? |
||
* when connecting to a source code repository. | ||
* | ||
* @default - do not use a token | ||
*/ | ||
|
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
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.