chore: clarify that breaking changes are for experimental APIs #9876
Conversation
Change the "BREAKING CHANGES" header in the CHANGELOG to "BREAKING CHANGES TO EXPERIMENTAL FEATURES" to make it sure that stable features are not being broken.
| sed -i.tmp -e 's/BREAKING CHANGES$/BREAKING CHANGES TO EXPERIMENTAL FEATURES/' CHANGELOG.md | ||
| rm CHANGELOG.md.tmp | ||
| git add CHANGELOG.md | ||
| git commit --amend --no-edit |
There was a problem hiding this comment.
was the alternative you considered before landing on sed?
making use of the lifecycle scripts? or other?
| # I've gone diving through the code of `conventional-changelog` to see if there | ||
| # was a way to configure the string and ultimately I decided that a 'sed' was the simpler | ||
| # way to go. | ||
| sed -i.tmp -e 's/BREAKING CHANGES$/BREAKING CHANGES TO EXPERIMENTAL FEATURES/' CHANGELOG.md |
There was a problem hiding this comment.
I like experimental features rather than modules since we do have experimental tagged in classes, APIs, etc in stable modules.
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
Change the "BREAKING CHANGES" header in the CHANGELOG to
"BREAKING CHANGES TO EXPERIMENTAL FEATURES" to make it sure that
stable features are not being broken.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license