Repository navigation
fix(release): take a changelog section for a tagged version as history - #38
Merged
Merged
Conversation
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What and why
A repository released by its root
CHANGELOG.rstcan only gain one version section per pull request, and only in arelease:one. That also refuses the changelog of releases made before the file existed, which every repository moving to changelog releases has, this one included.check_release_pr.py: a section for a version that already has av<version>tag is history, not a release. It no longer counts as an added section, so any pull request may add it. A section for an untagged version is checked as before.CHANGELOG.rst: the releases from 1.0.0 to 1.16.1, one section per tag, from the commits between them. 1.13.0 was tagged on the same commit as 1.12.0, so it reads "No changes."Testing
prepare_release.py --changelogover thisCHANGELOG.rst. It writes the 1.17.0 section on top and leaves the history as it is.check_changelog_format.pyreads the new file, and the shared pre-commit config passes.!and means the next release is a major version bump)Notes