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

chore: clarify that breaking changes are for experimental APIs #9876

Merged
merged 3 commits into from
Aug 20, 2020
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions bump.sh
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,13 @@ echo "Starting ${version} version bump"

# Generate CHANGELOG and create a commit (see .versionrc.json)
npx standard-version --release-as ${version}

# I am sorry.
#
# 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like experimental features rather than modules since we do have experimental tagged in classes, APIs, etc in stable modules.

rm CHANGELOG.md.tmp
git add CHANGELOG.md
git commit --amend --no-edit
Comment on lines +30 to +33
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

was the alternative you considered before landing on sed?
making use of the lifecycle scripts? or other?