[pipelines] GitHubSourceAction in README uses default branch 'master' which is no longer the default branch on GitHub #10906
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
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:
I propose just adding
branch: 'main', // default: 'master'
to the pipelines README.This is a 📕 documentation issue
The text was updated successfully, but these errors were encountered: