Repository navigation
Move the changelog to GitHub releases - #112
Merged
Merged
Conversation
The GitHub releases already contain the notes for each released version, and the release workflow generates notes for new releases. Remove CHANGELOG.md and point the README to the GitHub releases.
ScottifyShopson
approved these changes
Oct 27, 2026
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.
Motivation
The repository keeps release notes in two places:
CHANGELOG.mdand the GitHub releases. The GitHub releases already contain the notes of every released version. The release workflow from #108 also creates a GitHub release with generated notes for each new tag. A separateCHANGELOG.mdis then a second copy that maintainers must keep up to date.Changes
CHANGELOG.md.CHANGELOG.mdupdate. The README now points to the GitHub releases for the changes in each version.Notes
CHANGELOG.mdis already in the v0.3.0 release.