Standardize release notes: always significant-change highlights, never a size-based trim - #28
Merged
Conversation
…r a size-based trim Replaces the two different heuristics (a 1500-character cutoff, a 40-line cutoff) with one uniform rule applied unconditionally: the GitHub Release body is always just the significant-change bullets from CHANGELOG.md's matching section, plus a link back to CHANGELOG.md for the full write-up. CLAUDE.md now documents the bullet convention (bold one-line lead-ins) this release step depends on, so the highlights are ready in CHANGELOG.md by the time a release is cut, rather than computed by trimming or reflowing prose at release time.
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.
Summary
This replaces the ad hoc "dump the whole section, unless it's too long" approach with one uniform rule, applied the same way across CoverDex, 3DSAppManager, and ThePatientGamerHelper's
release.yml:CHANGELOG.md's matching section — never the full section text, and never gated by a character-count or line-count cutoff. That inconsistency (1500 chars in one repo's proposal, 40 lines in another's) is exactly what prompted this pass.CLAUDE.mdgets a new "Changelog Entries" section documenting the convention the extraction depends on: every version section leads with flat- **One-line summary.** ...bullets, so the highlights are always already "ready" inCHANGELOG.md— the workflow no longer has to guess by trimming or reflowing prose at release time.[1.0.0]prose entry, written before the convention existed) falls back to publishing the whole section as-is — a structural fallback for a section with nothing to extract, not a size-based judgment call.CHANGELOG.md's matching section, computed via GitHub's real heading-anchor slug algorithm.Supersedes #27, which proposed a 1500-character length cutoff — closing that PR in favor of this unconditional approach.
Test plan
python3 -c "import yaml; yaml.safe_load(open('.github/workflows/release.yml'))"— YAML parses.[1.1.0]-style entry with a nested elaboration bullet — correctly extracts just the top-level bold lead-ins, ignoring the nested one.## [1.0.0]heading (#100).workflow_dispatch(would cut a real release).Generated by Claude Code