Repository navigation
ci(release): reflow release notes; rewrite the 1.1.0 and 1.2.0 changelog in the 1.0.x style - #17
Merged
Merged
Conversation
CHANGELOG.md is hard-wrapped for editors, and the release page shows the notes as written, so every bullet arrived as a ragged column of short lines. changelog.py notes now joins each bullet's (and paragraph's) wrapped lines. Headings, blank lines, code fences, tables, block quotes, link references and nested bullets are left alone, and a trailing hard break is kept. Adds unit tests for the reflow (run in CI on Linux) and checked it against every released section: the words and the bullet count are identical. Co-Authored-By: Claude Sonnet 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_012GP39ZPN7EzLLdoKcJkGD4
The 1.2.0 section ran to about 1,160 words; it is now one short line per change (about 290 words). docs/RELEASING.md gains a short "Writing changelog entries" section (one line per change, user-visible effect, detail belongs in the PR or docs), and [Unreleased] records the reflow change. Co-Authored-By: Claude Sonnet 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_012GP39ZPN7EzLLdoKcJkGD4
1.0.0 and 1.0.1 are short one-line bullets that are easy to read and grep; 1.1.0 and 1.2.0 had grown into long wrapped paragraphs (about 1,375 and 1,160 words). Rewrite both as one short line per change with no hard wraps: 1.1.0 is now about 330 words and 1.2.0 about 190. Behaviour notes that only mattered to reviewers are dropped; what a user would notice is kept. Co-Authored-By: Claude Sonnet 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_012GP39ZPN7EzLLdoKcJkGD4
tmack8001
changed the title
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.
Description
The v1.2.0 release page showed
CHANGELOG.mdverbatim, so every bullet (hard-wrapped at ~80 columns for editors) arrived as a ragged column of short lines. The 1.1.0 and 1.2.0 sections had also drifted from the terse one-line style of 1.0.0 and 1.0.1 into long wrapped paragraphs (~1,375 and ~1,160 words). This fixes both: the notes script joins wrapped lines, the two sections are rewritten in the 1.0.x style, and the docs say how to write entries.Type of Change
Changes Made
.github/scripts/changelog.py notesnow reflows its output: each bullet or paragraph becomes one line. Headings, blank lines, code fences (and their contents), tables, block quotes, link references and nested bullets are left alone, and a trailing hard break is kept.checkandrollare unchanged..github/scripts/test_changelog.py: 10 unit tests for the reflow, run in CI (python3 -m unittest discover -s .github/scripts, Linux jobs only). The reflow was also run over every released section: words and bullet counts are identical, only line breaks change.CHANGELOG.md: the[1.1.0]section (~1,375 -> ~330 words) and the[1.2.0]section (~1,160 -> ~190 words) are rewritten as one short line per change, with no hard wraps, in the style of 1.0.0/1.0.1. What a user would notice is kept; reviewer-level detail is dropped.[Unreleased]records the reflow change.docs/RELEASING.md: new "Writing changelog entries" section (one line per change, user-visible effect, detail belongs in the PR or docs).Platform(s) Affected
Testing
changelog.py checkstill passes, andchangelog.py notes 1.1.0/notes 1.2.0print one line per bullet. Merging does not change the already-published release pages. To update them from a maintainer machine after merge:Checklist
Documentation
docs/folder🤖 Generated with Claude Code
https://claude.ai/code/session_012GP39ZPN7EzLLdoKcJkGD4