Trim release notes to highlights when the changelog entry is huge - #18
Closed
Marcogn wants to merge 1 commit into
Closed
Trim release notes to highlights when the changelog entry is huge#18Marcogn wants to merge 1 commit into
Marcogn wants to merge 1 commit into
Conversation
The "Extract changelog section for this version" step used to hand the whole cut CHANGELOG.md section to the GitHub Release body verbatim, regardless of length -- fine for short entries, but this project's entries routinely run to several thousand characters across many "### " subsections (see v2.4.0), making for an unreadable release page. Sections at or under 1500 characters still work that way; past that, the body is reduced to the section's "### " subsection headings (or its top-level "- **bold**" bullets, for a version with no subsections) plus a link back to CHANGELOG.md for the full write-up. Same change applied to CoverDex's release.yml for consistency between the two pipelines. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VQrE6ntdCMh5JQfS5m5WVL
4 tasks
Owner
Author
|
Superseded by #19, which drops the 40-line cutoff entirely in favor of always extracting significant-change highlights (uniform with the same change in CoverDex and ThePatientGamerHelper). Closing this in favor of that PR. Generated by Claude Code |
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
2 participants
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
release.yml's "Extract changelog section for this version" step used to hand the entire cut## vX.Y.Zsection tosoftprops/action-gh-releaseverbatim, no matter its length — this project's entries routinely run to several thousand characters across many###subsections (e.g.v2.4.0), making for an unreadable release page.###subsection headings (or its top-level- **bold**bullets, for a version with no subsections), followed by a link back toCHANGELOG.mdfor the full write-up.## UnreleasedCHANGELOG.mdentry for this change, and updated the file's intro note to describe the new behavior.Marcogn/CoverDex'srelease.ymlfor consistency between the two pipelines (separate PR).Test plan
python3 -c "import yaml; yaml.safe_load(open('.github/workflows/release.yml'))"— YAML parses.make test— all host suites still pass (17 + 13 + 6 tests), unaffected since this change touches only the workflow/changelog, notsource/.CHANGELOG.md'sv2.4.0section (12408 chars, 8 subsections) — correctly collapses to an 8-line highlight list plus the CHANGELOG.md link.workflow_dispatch(would cut a real release, and the real build requires devkitARM which isn't available in this sandbox).Generated by Claude Code