Repository navigation
docs(release): write the release notes by hand, short and in user terms - #59
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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 v1.1.0 release went out with the workflow's fixed placeholder as its notes. Nothing in the release skill asked for notes to be written. The first notes written by hand were then far too long.
What it adds to
farol-releasegh release edit.A new section, Write the release notes, sets the shape: New / Improved / Fixed, one line per change in the user's terms, and the compare link. It also lists what stays out: install and platform sections (the asset list already shows them), checksums, update steps, the signing notice, intros, bug stories, refactors, and internal names.
🤖 Generated with Claude Code