Refactor changelog for the new release process #2660
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This changes our changelog script to manage a single release, adding features for rc and multi-branch releases.
Copy/paste from the script docstring below.
This script allows adding or replacing individual release sections in our
CHANGELOG.md file.
It works on a set of simple principles
capture PRs (
release_to
or end release) and the release preceding it(
release_from
or start release)'Unreleased' block in changelog)
release (again to populate the 'Unreleased' block)
the release block
on:
labels, and flagged as containing incompatiblechanges if they have one of the
breaks:
labelsthe
merged_to
argument (defaulting tomaster
) are ignoredrelease_as
argument to prepare for a new releaseExample usage:
releases use defaults, only PRs to
master
are trackede.g. when releasing an rc2 with fast-dev aligned on master