Skip to content

Add a changelog, a backlog, and checksums to releases - #16

Merged
jay739 merged 1 commit into
mainfrom
chore/release-hygiene
Nov 9, 2026
Merged

jay739 merged 1 commit into
mainfrom
chore/release-hygiene

Conversation

@jay739

@jay739 jay739 commented Nov 9, 2026 •

Copy link
Copy Markdown
Owner

What

  • CHANGELOG.md records 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.md holds 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.yml writes SHA256SUMS.txt and 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.

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.
@jay739
jay739 merged commit 54d3c53 into main Nov 9, 2026
3 checks passed
@jay739
jay739 deleted the chore/release-hygiene branch November 9, 2026 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant