docs: drop redundant 'What's Changed' dump from release notes#248
Open
pinodeca wants to merge 1 commit into
Open
docs: drop redundant 'What's Changed' dump from release notes#248pinodeca wants to merge 1 commit into
pinodeca wants to merge 1 commit into
Conversation
Step 5 of the release prompt concatenated the entire `releases/generate-notes` body, which re-listed every PR in a flat 'What's Changed' section that just duplicates the curated CHANGELOG block (ungrouped). Trim it with awk so the auto block contributes only 'New Contributors' + the 'Full Changelog' link; the per-PR list with attribution stays one click away via the compare link. Observed on the v0.2.3 release, whose notes have been trimmed to match.
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.
Trims the auto-generated block in the release prompt's Step 5 so release notes stop carrying a redundant "What's Changed" PR dump.
Problem
Step 5 concatenated the entire
releases/generate-notesbody onto the curatedCHANGELOG.mdsection. That body's## What's Changedis a flat list of every merged PR — which just re-states the same PRs the curated changelog already describes (grouped by Added/Changed/Fixed/etc.). Net effect on every release: readers get the same information twice, once curated and once as an ungrouped dump.Observed on the v0.2.3 notes (now trimmed to match).
Change
Pipe the API output through
awkthat drops lines from the## What's Changedheading until the next##heading or the**Full Changelog**line — keeping only New Contributors + the Full Changelog compare link. Anyone wanting the exhaustive per-PR list with attribution is one click away via that link.Validated against the real v0.2.3
generate-notesoutput: result is exactly## New Contributors+**Full Changelog**.Docs/process-only change — no code, SQL, or workflow files touched.