Skip to content

Write release notes by hand - #21

Merged
TerrifiedBug merged 1 commit into
mainfrom
docs/changelog
Sep 4, 2026
Merged

Write release notes by hand#21
TerrifiedBug merged 1 commit into
mainfrom
docs/changelog

Conversation

@TerrifiedBug

Copy link
Copy Markdown
Owner

The 0.3.0 release notes read:

What's Changed

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.md holds 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.

body and generate_release_notes are 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

  • extraction returns the 0.3.0 section, 64 lines, stopping cleanly at the next ## heading (0 leaked);
  • a version with no section extracts 0 bytes, which trips the guard and fails the job;
  • the workflow still parses, 10 named steps in order.

The published v0.3.0 notes have been rewritten from this file so the release and the changelog agree.

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.
@TerrifiedBug
TerrifiedBug merged commit a0d356c into main Sep 4, 2026
1 check passed
@TerrifiedBug
TerrifiedBug deleted the docs/changelog branch September 4, 2026 08:20
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