feat: abridge release notes for a large changelog entry, link to CHANGELOG.md - #17
Merged
Merged
Conversation
…GELOG.md v2.4.0's own Release ended up as a ~200-line dump since release.yml always used the full "## Unreleased" section verbatim as the Release body. Now a short section (<=40 lines) is still used in full; a long one is abridged to just its "### " entry headings as a bullet list. Either way the Release body always ends with a link back to CHANGELOG.md's matching dated section, using a slug generator verified against this repo's real rendered GitHub anchors (periods get dropped from the version number, not turned into hyphens).
Marcogn
marked this pull request as ready for review
August 19, 2026 14:45
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
v2.4.0's own GitHub Release ended up as a ~200-line wall of text, since.github/workflows/release.yml's "Extract changelog section for this version" step always dumped the full## Unreleasedsection verbatim into the Release body.###entry headings — each already written as a one-line summary by this file's own convention — as a bullet list.CHANGELOG.md's matching dated section for the full detail.The link's
#fragmentreproduces GitHub's actual heading-anchor slug algorithm (lowercase; drop everything that isn'ta-z0-9 _-; spaces → hyphens) — verified against this repo's own real rendered CHANGELOG.md anchors via the live page, e.g.v2.4.0 (2026-08-19)renders asid="v240-2026-08-19"(periods get dropped from the version number entirely, not turned into hyphens — an easy thing to get subtly wrong).Test plan
python3 -c "import yaml; yaml.safe_load(...)"— workflow YAML parses cleanlydashagainst this repo's actual hugev2.4.0CHANGELOG.md section (198 lines, 8###headings): correctly abridges to the 8-bullet highlight list + a working link, and the computed slug (v240-2026-08-19) matches the real GitHub-rendered anchor for that exact heading, confirmed via a live fetch of the rendered pageReleaseworkflow (best confirmed on the next actual release)Generated by Claude Code