Repository navigation
Add a changelog, a backlog, and checksums to releases - #16
Merged
Merged
Conversation
CHANGELOG.md records every release so far, with an entry for 0.3.0. Each bullet is a single line, so an entry can go straight into the GitHub release notes without stray line breaks. BACKLOG.md holds work that is understood but not done yet, ordered by how much it hurts to leave undone, starting with the hands-on checks the next release still needs. The release workflow now writes SHA256SUMS.txt and publishes it with the dmg and the installer.
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
CHANGELOG.mdrecords every release so far and has the 0.3.0 entry for this release. Each bullet is a single line, so an entry can go straight into the release notes.BACKLOG.mdholds work that is understood but not done, ordered by impact: the hands-on checks this release still needs, hdiutil's deprecation on macOS 27, the outdated Windows README, compiler warnings and the remaining em dashes.release.ymlwritesSHA256SUMS.txtand publishes it with the dmg and the installer.Why
Every release should state its changes, carry checksums for its downloads, and keep the version in the tag, the build and the changelog in step. The backlog keeps deferred work written down in one place instead of buried in old PRs and commit messages.
How it was tested
Docs plus a release-only workflow step; the checksum step runs on the next tag push, and the release will be checked for
SHA256SUMS.txt.