defer to the GitHub releases page as the canonical changelog #48
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 PR updates:
Changelog
The CHANGELOG.md file has fallen out of sync. The information tracked between this file and the GitHub releases page differed (before I synced them).
In order to ease the maintenance of the changelog, especially since goreleaser will maintain it with git commit information, we should defer to the GitHub releases page.
Goreleaser only lists the commit messages between releases. Maintainers should adjust the release notes (which is something they were doing anyway) to make it easier for users to understand what changed between releases at a high level.
I find that the automated release process, along with the human process of release notes editing, and the inclusion of a CHANGELOG.md that refers to the GitHub URL satisfy the concerns stated on Keep a Changelog: