Document the GitHub release body convention - #60
Merged
Conversation
The changelog's releasing paragraph covers the three version markers and the tag, but never said what goes in the release body. Each release session guessed: 1.1.2 and 1.3.0/1.4.0 pasted the changelog section verbatim, 1.1.3 reworded it under its own heading, and 1.2.0 wrote a summary. `make release` and the ship flow do not touch `gh release`, so there is no template to fall back on. Changelog entries have also grown denser, so the paste that was tolerable at 1.1.2 made 1.3.0 and 1.4.0 unreadable. Record the summary format the 1.2.0 release used. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
next-devin
marked this pull request as ready for review
September 8, 2026 03:40
Code Review SummaryStatus: No Issues Found | Recommendation: Merge Files Reviewed (1 file)
Reviewed by minimax-m3 · Input: 21.9K · Output: 1.2K · Cached: 183.7K |
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
1 participant
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.
Why
Spark's release bodies have no convention, so each release session invented one:
## What's changedheading, bullets lightly reworded### Highlights+ 5 condensed bullets + changelog link1.2.0 was one session's improvement that never got written down, so the next two reverted to the copy-paste habit. Two things make that habit worse now than it was at 1.1.2:
make releaseand the ship flow never touchgh release, so the body is hand-assembled with no template.What changed
One paragraph added to the releasing note at the top of
CHANGELOG.md: the release body is a summary (framing sentence,### Highlightsof at most five bullets, link toCHANGELOG.mdat the tag), not a copy of the section, with 1.2.0 named as the reference format.The 1.3.0 and 1.4.0 release bodies have already been rewritten to that format on GitHub. No changelog entry text was touched.
🤖 Generated with Claude Code