Skip to content

Commit 0b9e11b

Browse files
committed
update repo comment
1 parent bd47ebc commit 0b9e11b

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

Diff for: packages/@aws-cdk/aws-amplify-alpha/README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import * as codebuild from 'aws-cdk-lib/aws-codebuild';
2727
const amplifyApp = new amplify.App(this, 'MyApp', {
2828
sourceCodeProvider: new amplify.GitHubSourceCodeProvider({
2929
owner: '<github-username>',
30-
repository: '<repository-name>',
30+
repository: '<repository-name>', // Just the repository name, NOT the full repository URL
3131
accessToken: SecretValue.secretsManager('my-github-token'),
3232
}),
3333
buildSpec: codebuild.BuildSpec.fromObjectToYaml({
@@ -62,7 +62,7 @@ To connect your `App` to GitLab, use the `GitLabSourceCodeProvider`:
6262
const amplifyApp = new amplify.App(this, 'MyApp', {
6363
sourceCodeProvider: new amplify.GitLabSourceCodeProvider({
6464
owner: '<gitlab-namespace-or-group>',
65-
repository: '<repository-name>',
65+
repository: '<repository-name>', // Just the repository name, NOT the full repository URL
6666
oauthToken: SecretValue.secretsManager('my-gitlab-token'),
6767
}),
6868
});
@@ -159,7 +159,7 @@ Use `BasicAuth.fromCredentials` when referencing an existing secret:
159159
const amplifyApp = new amplify.App(this, 'MyApp', {
160160
sourceCodeProvider: new amplify.GitHubSourceCodeProvider({
161161
owner: '<github-username>',
162-
repository: '<repository-name>', // Just the repository name, NOT the full URL
162+
repository: '<repository-name>', // Just the repository name, NOT the full repository URL
163163
accessToken: SecretValue.secretsManager('my-github-token'),
164164
}),
165165
basicAuth: amplify.BasicAuth.fromCredentials('username', SecretValue.secretsManager('my-github-token')),
@@ -171,8 +171,8 @@ Use `BasicAuth.fromGeneratedPassword` to generate a password in Secrets Manager:
171171
```ts
172172
const amplifyApp = new amplify.App(this, 'MyApp', {
173173
sourceCodeProvider: new amplify.GitHubSourceCodeProvider({
174-
owner: '<user>',
175-
repository: '<repo>',
174+
owner: '<github-username>',
175+
repository: '<repository-name>', // Just the repository name, NOT the full repository URL
176176
oauthToken: SecretValue.secretsManager('my-github-token'),
177177
}),
178178
basicAuth: amplify.BasicAuth.fromGeneratedPassword('username'),
@@ -197,7 +197,7 @@ of branches:
197197
const amplifyApp = new amplify.App(this, 'MyApp', {
198198
sourceCodeProvider: new amplify.GitHubSourceCodeProvider({
199199
owner: '<github-username>',
200-
repository: '<repository-name>', // Just the repository name, NOT the full URL
200+
repository: '<repository-name>', // Just the repository name, NOT the full repository URL
201201
accessToken: SecretValue.secretsManager('my-github-token'),
202202
}),
203203
autoBranchCreation: { // Automatically connect branches that match a pattern set
@@ -214,8 +214,8 @@ Use the `customResponseHeaders` prop to configure custom response headers for an
214214
```ts
215215
const amplifyApp = new amplify.App(this, 'App', {
216216
sourceCodeProvider: new amplify.GitHubSourceCodeProvider({
217-
owner: '<user>',
218-
repository: '<repo>',
217+
owner: '<github-username>',
218+
repository: '<repository-name>', // Just the repository name, NOT the full repository URL
219219
oauthToken: SecretValue.secretsManager('my-github-token'),
220220
}),
221221
customResponseHeaders: [

0 commit comments

Comments
 (0)