ci: take the release page's prose from the CHANGELOG too - #391
Open
gloryfromca wants to merge 1 commit into
Open
ci: take the release page's prose from the CHANGELOG too#391gloryfromca wants to merge 1 commit into
gloryfromca wants to merge 1 commit into
Conversation
Leaving the lead summary and the upgrade notes to be composed at publish time put the writing at the worst possible moment — weeks after the changes, with no review. Both belong in the CHANGELOG entry, which the release PR is already editing. The lead needed no code: text between the version heading and the first group already flowed into the page. The Upgrade group did — CI appended its own `## Upgrade`, so a CHANGELOG that carried upgrade notes produced two headings. The group is now lifted out and the boilerplate wrapped around it, pip line above, compare link below, matching every page since 1.1.3. Publishing is now a read-through and a click. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
Follow-up to #389. That PR left two things to be written at publish time — the lead summary and the upgrade notes — which is the worst moment for it: the changes are weeks old by then and the text gets no review. Both belong in the CHANGELOG entry the release PR is already editing.
## [X.Y.Z]and the first###group already flowed into the page; it was just never documented, so nobody wrote it there.## Upgrade, so a CHANGELOG carrying upgrade notes produced two headings. The group is now lifted out of the extracted body and the boilerplate wrapped around it — pip line above, prose in the middle, compare link below — which is the shape of every release page since 1.1.3.Publishing becomes a read-through and a click.
Area
Verification
Extraction re-run from the workflow YAML against a fixture repo (CHANGELOG with a lead paragraph and an
### Upgradegroup, tagsv1.2.2/v1.3.0) and against the realCHANGELOG.md:Output for the fixture matches the hand-written v1.2.1 page section for section.
Checklist
main..envfiles, dependency folders, or generated output.Notes for Reviewers
The
/releaseskill now shows the CHANGELOG entry as the source of the page and says to omit the### Upgradegroup when there is nothing to say — 1.1.4 and 1.2.0 have nothing there, and prompting for filler is how a section becomes noise.Still unverified end to end: the job has never run on a real tag push. Same open question as #389 — an rc tag would settle it.
🤖 Generated with Claude Code