Write release notes by hand - #21
Merged
Merged
Conversation
The 0.3.0 release said "What's Changed: Make the app the product, not the CLI" and linked two pull requests. That is what was merged, which is not what changed for the person installing it — nothing in it mentions that the hotkey is now recorded, or that Delete exists, or that seven commands went away. CHANGELOG.md holds the notes, in the same plain register as the README, and the release job reads the section matching the tag. It runs before the build rather than after, so a version with no section fails in seconds instead of once Apple has finished notarizing it — an empty section counts as missing, because it is the same mistake. `body` and `generate_release_notes` together: GitHub puts the written notes first and appends the merged-PR list and the full-changelog link underneath, so the notes lead and the provenance stays one click away. Older releases are left alone; the file says where to find them.
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.
The 0.3.0 release notes read:
That is what was merged. It is not what changed for the person installing it — nothing in it mentions that the hotkey is now recorded rather than picked, that the transcript banner gained Delete, or that seven commands went away.
What this does
CHANGELOG.mdholds the notes, in the same register as the README — what changed for a user, not a log of commits. The release job reads the section matching the tag and publishes it.The read happens before the build, not after: a version with no section fails in seconds rather than once Apple has finished notarizing it. An empty section counts as missing, because it is the same mistake.
bodyandgenerate_release_notesare both set. GitHub puts the written notes first and appends its own merged-PR list and full-changelog link underneath, so the notes lead and the provenance stays one click away.Older releases are left alone; the file says where to find them.
Checked
##heading (0 leaked);The published v0.3.0 notes have been rewritten from this file so the release and the changelog agree.