frankenbit/release-toolkit
frankenbit/release-toolkit
15
1
Fork 0
Code Issues 11 Pull requests Projects Releases 106 Packages 1 Wiki Activity Actions

docs(changelog.d): convert six v0.35.0 fragments to one-liner bullets #630

Closed
herald wants to merge 1 commit from i/627-fragments-to-one-liners into main
pull from: i/627-fragments-to-one-liners
merge into: frankenbit:main
Conversation 0 Commits 1 Files changed 6 +7 -25
herald commented 2026-07-31 15:37:14 +02:00
Owner
Copy link

Round 2 on #627. Alex named PR#552 (v0.34.0) as the target; this converts the six
v0.35.0 fragments to one-liner bullets matching its shape.

Why distillation could not have worked

#552 touched zero changelog.d/ files. All 50 entries were commit subjects, so the
composer emitted one-liners. The slim look was the absence of prose, not a prose
style — three sentences is still three sentences more than a bullet. Verified by
Bosun and reproduced here against the merged v0.34.0 section.

Matched the measured envelope, not a description of it

v0.34.0, 50 entries   - **scope**: summary     49/50 carry the scope prefix
                       words  min 7 · median 10 · max 17
this PR, 7 bullets     words  min 8 · median 14 · max 17

Result

composed body   3037  →  2056 (#628 prose distillation)  →  848 chars
changelog-body-check   9/9 PASS, zero warnings
fragment-check         exit 0

✅ Check 5's mixed bullet+prose warning clears as a side effect — each section now has
exactly one form. That is part of #627 answering itself.

The 605 call — kept, as a second bullet

- **ci**: fail when the release-shape `rt` binary grows >20% over the last release's asset (#605)
- **ci**: a "could not grade" green means no baseline was reachable, not a passing size (#605)

I considered attaching the disclosure to the capability bullet and rejected it. The
combined form ran 28 words against a median of 10 — it would have been the one bulky
line in a section whose entire point is uniformity, reintroducing the reported problem in
the single place a reader is most likely to stop.

Why keep it at all, given /srv/CLAUDE.md § Mechanism design puts the disclosure at
the point of use and the CI output already carries it: the changelog bullet is where an
adopter forms the belief "I am protected against size regressions." A capability claim
is itself a point of use. One line is cheap insurance against a green being trusted for
the wrong reason.

Not in scope

  • The three commit-subject bullets already in ### Added are untouched.
  • (#NNN) refs kept on all seven — only 17/50 of v0.34.0's carried one, but they are
    more useful in bullet form, not less.

Refs #627. No close keyword.

Round 2 on #627. Alex named PR#552 (v0.34.0) as the target; this converts the six v0.35.0 fragments to one-liner bullets matching its shape. ## Why distillation could not have worked **#552 touched zero `changelog.d/` files.** All 50 entries were commit subjects, so the composer emitted one-liners. **The slim look was the absence of prose, not a prose style** — three sentences is still three sentences more than a bullet. Verified by Bosun and reproduced here against the merged v0.34.0 section. ## Matched the measured envelope, not a description of it ``` v0.34.0, 50 entries - **scope**: summary 49/50 carry the scope prefix words min 7 · median 10 · max 17 this PR, 7 bullets words min 8 · median 14 · max 17 ``` ## Result ``` composed body 3037 → 2056 (#628 prose distillation) → 848 chars changelog-body-check 9/9 PASS, zero warnings fragment-check exit 0 ``` ✅ **Check 5's mixed bullet+prose warning clears as a side effect** — each section now has exactly one form. That is part of #627 answering itself. ## The `605` call — kept, as a second bullet ``` - **ci**: fail when the release-shape `rt` binary grows >20% over the last release's asset (#605) - **ci**: a "could not grade" green means no baseline was reachable, not a passing size (#605) ``` **I considered attaching the disclosure to the capability bullet and rejected it.** The combined form ran **28 words against a median of 10** — it would have been the one bulky line in a section whose entire point is uniformity, reintroducing the reported problem in the single place a reader is most likely to stop. **Why keep it at all**, given `/srv/CLAUDE.md` § Mechanism design puts the disclosure at the *point of use* and the CI output already carries it: the changelog bullet is where an adopter forms the belief *"I am protected against size regressions."* **A capability claim is itself a point of use.** One line is cheap insurance against a green being trusted for the wrong reason. ## Not in scope - The three commit-subject bullets already in `### Added` are untouched. - `(#NNN)` refs kept on all seven — only 17/50 of v0.34.0's carried one, but they are more useful in bullet form, not less. Refs #627. No close keyword.
docs(changelog.d): convert six v0.35.0 fragments to one-liner bullets
All checks were successful
check-self-bootstrap / check (pull_request) Successful in 3s
Details
fragment-check / changelog fragment-kind (pull_request) Successful in 4s
Details
fragment-check / check (pull_request) Successful in 0s
Details
go-ci / lint + build + test (pull_request) Successful in 32s
Details
manifest-check / manifest-vs-tag consistency (pull_request) Successful in 5s
Details
manifest-check / check (pull_request) Successful in 0s
Details
register-check / register-drift check (pull_request) Successful in 4s
Details
register-check / check (pull_request) Successful in 0s
Details
tests / bats (pull_request) Successful in 2m9s
Details
tests / shellcheck (pull_request) Successful in 9s
Details
380075995d 
Alex named v0.34.0 (PR#552) as the target shape. That cut touched zero
changelog.d/ files, so all 50 entries were commit subjects and the
composer emitted one-liners. The slim look was the absence of prose, not
a prose style — so distillation could not reach it and the fix is a form
change.

Matched #552's measured envelope rather than a description of it:
`- **scope**: summary (#ref)`, 49/50 with the scope prefix, words
min 7 / median 10 / max 17. All seven bullets here land inside it.

605 keeps its scope disclosure as a second bullet. A one-bullet form
carrying both ran 28 words and would have been the one bulky line in a
section whose point is uniformity — reintroducing the problem in the
place it matters most.

Composed body 3037 -> 2056 (prose distillation) -> 848 chars.
changelog-body-check: 9/9 PASS, no warnings — check 5's mixed
bullet+prose warning clears as a side effect, since each section now
has one form.

Refs #627.
herald closed this pull request 2026-07-31 15:40:51 +02:00
Some checks are pending
check-self-bootstrap / check (pull_request) Successful in 3s
Required
Details
fragment-check / changelog fragment-kind (pull_request) Successful in 4s
Details
fragment-check / check (pull_request) Successful in 0s
Required
Details
go-ci / lint + build + test (pull_request) Successful in 32s
Required
Details
manifest-check / manifest-vs-tag consistency (pull_request) Successful in 5s
Required
Details
manifest-check / check (pull_request) Successful in 0s
Required
Details
register-check / register-drift check (pull_request) Successful in 4s
Required
Details
register-check / check (pull_request) Successful in 0s
Required
Details
tests / bats (pull_request) Successful in 2m9s
Required
Details
tests / shellcheck (pull_request) Successful in 9s
Required
Details
ac-closure-check / ac-closure check (pull_request)
Required
ac-closure-check / check (pull_request)
Required
changelog-body-check / changelog body Cold-Read linter (pull_request)
Required
changelog-body-check / check (pull_request)
Required
fragment-check / coverage (pull_request)
Required
fragment-check / density (pull_request)
Required
gitea-twin-check / check (pull_request)
Required
prep-order-check / check (pull_request)
Required
readme-pin-check / digest (pull_request)
Required
tests / contract-paths (pull_request)
Required
tests / dated-examples (pull_request)
Required
tests / workflow-schema (pull_request)
Required
toolkit-self-gates / toolkit-self gates (PR's own rt) (pull_request)
Required
workflow-parse-check / check (pull_request)
Required
workflow-parse-check / toolkit-self parse guard and controls (pull_request)
Required
workflow-parse-check / workflow parse and schema (pull_request)
Required

Pull request closed

This pull request cannot be reopened because the branch was deleted.
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
bump
major
 Override the cut bump to MAJOR (release-toolkit#107)

  
bump
minor
 Override the cut bump to MINOR (release-toolkit#107)

  
bump
patch
 Override the cut bump to PATCH (release-toolkit#107)

  
kind/bug
Something is broken

  
kind/chore
Maintenance, tooling, refactor

  
kind/docs
Documentation work

  
kind/feature
New feature or capability

  
priority/critical
Critical: must be addressed immediately

  
priority/high
Important, should be addressed soon

  
priority/low
Low priority, address when convenient

  
priority/medium
Normal priority

  
size/L
Large: significant feature, ~6-16h

  
size/M
Medium: moderate feature, ~2-6h

  
size/S
Small: simple change, ~1-2h

  
size/XL
Extra large: major feature or refactor, 16h+

No labels
bump
major
bump
minor
bump
patch
kind/bug
kind/chore
kind/docs
kind/feature
priority/critical
priority/high
priority/low
priority/medium
size/L
size/M
size/S
size/XL
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
frankenbit/release-toolkit!630
No description provided.