docs(changelog): one title and one Unreleased, lines moved only (refs #1980) #2228

Merged
jaylouisw merged 1 commit from fix/1120-0002 into main 2026-11-20 00:37:51 +00:00
Owner

Refs #1980 — step 1 of six in docs/plans/changelog-discipline.md. It does not finish the plan.

What was wrong

CHANGELOG.md opened on ## Unreleased at :1, reached its own # Changelog title at :640
(filed under a server-CORS entry), and then declared two further unreleased sections — ## Unreleased
at :647 and ## [Unreleased] at :750. Three headings for one release, none of them at the top,
so a writer adding an entry had to guess which one is live.

What changed

Lines moved, prose untouched:

  • # Changelog and its Keep-a-Changelog preamble (6 lines) to line 1.
  • One ## Unreleased at :8. The old :647-749 block follows the first block's last entry, then the
    old :750-864 block, in their existing order.
  • ## [0.1.0] - 2026-11-07 stays last; the footer keeps its one pair of link definitions.

Reviewed diff: 7 insertions, 11 deletions — the title block moves up, the two redundant headings go.
A throwaway script (not committed, per the plan) checked that the multiset of non-blank lines is
unchanged except for those two headings: 816 → 814 non-blank lines, 884 → 880 lines.

Deliberately not done here: the 18 category headings stay as they are (step 3), no entry is reworded
(step 5), no test yet (step 2 lands next and is what keeps this from re-fragmenting).

Tests

  • node scripts/syntax-check.js — 472 files, all OK
  • node test/canonical-urls.test.js — 58 passed, 0 failed (the one suite that reads this file)
  • npm test — 392 suites, 13,168 assertions passed, 0 failed
  • node scripts/check-control-bytes.js, node scripts/check-doc-citations.js — clean
Refs #1980 — step 1 of six in `docs/plans/changelog-discipline.md`. It does not finish the plan. ## What was wrong `CHANGELOG.md` opened on `## Unreleased` at `:1`, reached its own `# Changelog` title at `:640` (filed under a server-CORS entry), and then declared two further unreleased sections — `## Unreleased` at `:647` and `## [Unreleased]` at `:750`. Three headings for one release, none of them at the top, so a writer adding an entry had to guess which one is live. ## What changed Lines moved, prose untouched: - `# Changelog` and its Keep-a-Changelog preamble (6 lines) to line 1. - One `## Unreleased` at `:8`. The old `:647-749` block follows the first block's last entry, then the old `:750-864` block, in their existing order. - `## [0.1.0] - 2026-11-07` stays last; the footer keeps its one pair of link definitions. Reviewed diff: 7 insertions, 11 deletions — the title block moves up, the two redundant headings go. A throwaway script (not committed, per the plan) checked that the multiset of non-blank lines is unchanged except for those two headings: 816 → 814 non-blank lines, 884 → 880 lines. Deliberately not done here: the 18 category headings stay as they are (step 3), no entry is reworded (step 5), no test yet (step 2 lands next and is what keeps this from re-fragmenting). ## Tests - `node scripts/syntax-check.js` — 472 files, all OK - `node test/canonical-urls.test.js` — 58 passed, 0 failed (the one suite that reads this file) - `npm test` — 392 suites, 13,168 assertions passed, 0 failed - `node scripts/check-control-bytes.js`, `node scripts/check-doc-citations.js` — clean
docs(changelog): one title and one ## Unreleased, lines moved only (refs #1980)
All checks were successful
CI / Classify the change (pull_request) Successful in 13s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 10s
CI / Test (Node 18) (pull_request) Successful in 57s
CI / Test (Node 20) (pull_request) Successful in 57s
CI / Test (Node 22) (pull_request) Successful in 54s
CI / Server smoke and Docker build (pull_request) Successful in 19s
CI / Arm auto-merge (pull_request) Successful in 6s
0368dfe768
`CHANGELOG.md` opened with `## Unreleased` at :1, reached its own
`# Changelog` title at :640 under a server-CORS entry, and then
declared two more unreleased sections (`## Unreleased` at :647,
`## [Unreleased]` at :750). Three headings for one release, none of
them where a writer appends.

Step 1 of the plan in `docs/plans/changelog-discipline.md` (PR 1980):
the title and its Keep-a-Changelog preamble move to line 1, the three
blocks are appended in their existing order under a single
`## Unreleased`, and `0.1.0` stays last with one pair of link
definitions. No prose edited - a throwaway script verified the
multiset of non-blank lines is unchanged but for the two redundant
headings.

Categories (18 headings for 6) are step 3 of the plan, not this PR.
forgejo-actions scheduled this pull request to auto merge when all checks succeed 2026-11-20 00:11:57 +00:00
jaylouisw deleted branch fix/1120-0002 2026-11-20 00:37:52 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
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
jaylouisw/packetforge!2228
No description provided.