Skip to content
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

[pipelines] GitHubSourceAction in README uses default branch 'master' which is no longer the default branch on GitHub #10906

Closed
yattoni opened this issue Oct 15, 2020 · 3 comments · Fixed by #10907
Assignees
Labels
@aws-cdk/pipelines CDK Pipelines library documentation This is a problem with documentation. effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. good first issue Related to contributions. See CONTRIBUTING.md p1

Comments

@yattoni
Copy link
Contributor

yattoni commented Oct 15, 2020

GitHubSourceAction in README uses default branch 'master' which is no longer the default branch on GitHub

Issue is here:
https://docs.aws.amazon.com/cdk/api/latest/docs/pipelines-readme.html
more specifically
https://github.com/aws/aws-cdk/blame/1fbb8bcc5f1aa76710d286f78a59370438a7d0a4/packages/%40aws-cdk/pipelines/README.md#L145-L152

Following the README will cause the first attempt to deploy fail because the pipeline will try and pull from the 'master' branch which does not exist. This is a poor customer experience having to make another pr to change the branch.

The codepipeline-actions README already accounts for this:

const sourceAction = new codepipeline_actions.GitHubSourceAction({
  actionName: 'GitHub_Source',
  owner: 'awslabs',
  repo: 'aws-cdk',
  oauthToken: cdk.SecretValue.secretsManager('my-github-token'),
  output: sourceOutput,
  branch: 'develop', // default: 'master'
});

I propose just adding branch: 'main', // default: 'master' to the pipelines README.


This is a 📕 documentation issue

@yattoni yattoni added documentation This is a problem with documentation. feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Oct 15, 2020
@github-actions github-actions bot added the @aws-cdk/pipelines CDK Pipelines library label Oct 15, 2020
@skinny85
Copy link
Contributor

Sounds good @yattoni , care to open us a PR fixing this? Here's our docs: https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md

Thanks,
Adam

@skinny85 skinny85 added effort/small Small work item – less than a day of effort good first issue Related to contributions. See CONTRIBUTING.md p1 and removed needs-triage This issue or PR still needs to be triaged. labels Oct 16, 2020
@yattoni
Copy link
Contributor Author

yattoni commented Oct 16, 2020

Sure, I can open a PR @skinny85

yattoni added a commit to yattoni/aws-cdk that referenced this issue Oct 16, 2020
@mergify mergify bot closed this as completed in #10907 Oct 16, 2020
mergify bot pushed a commit that referenced this issue Oct 16, 2020
Closes: #10906


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/pipelines CDK Pipelines library documentation This is a problem with documentation. effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. good first issue Related to contributions. See CONTRIBUTING.md p1
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants