Repository navigation
Document that release notes are generated from pull requests - #1120
Merged
Merged
Conversation
The CHANGELOG has been updated at release time since 1.3.6, with each version linking to its generated GitHub release notes, so contributors no longer need to edit it.
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
1 participant
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.
CONTRIBUTING.mdasks contributors to update the CHANGELOG, but no merged pull request has added an entry since 1.3.4. Since 1.3.6, the CHANGELOG has been written at release time, and each version's section links to the GitHub release notes generated from merged pull request titles (.github/release.yml). Contributors who follow the guide, such as #1119, add entries that then have to be removed.This replaces the step with a note that release notes come from pull request titles, and says what the README's release-time CHANGELOG update contains.