Skip to content

chore(changelog): collapse stale Unreleased blocks released in 0.0.10/0.0.11 - #283

Merged
aram-devdocs merged 2 commits into
mainfrom
chore/changelog-cleanup
May 8, 2026
Merged

chore(changelog): collapse stale Unreleased blocks released in 0.0.10/0.0.11#283
aram-devdocs merged 2 commits into
mainfrom
chore/changelog-cleanup

Conversation

@aram-devdocs

Copy link
Copy Markdown
Owner

Summary

  • Removes the duplicate ## [Unreleased] block (between [0.0.11] and [0.0.10]) whose entries (Homebrew tap publish job, npm publish job) already shipped in 0.0.10 and 0.0.11. The 0.0.11 Bug Fixes block already documents the wiring (fix(ci): wire homebrew + npm publish jobs into release.yml #272).
  • Removes the second stale ## [Unreleased] block at the bottom of the file. Every line in it has been incorporated into a versioned section above (e.g. e2e matrix and baseline/rhythm in 0.0.2, x86_64-apple-darwin drop in 0.0.10, etc.).
  • No empty placeholder is kept. release-please (release-type: simple) generates ## [x.y.z] sections from conventional commits at release time and does not consume [Unreleased]. The CHANGELOG header already forbids hand-editing released sections.

Why

From the public-surface readiness audit. Closes finding H18. The duplicate [Unreleased] block confused the diff and risked release-please mis-handling the next release.

Test plan

  • grep -c '^## \[Unreleased\]' CHANGELOG.md returns 0 (zero manual blocks).
  • All remaining ## headings are released versions in descending order: 0.0.11 → 0.0.2.
  • just validate passes (fmt, clippy -D warnings, full test suite, determinism check, cargo-deny).
  • release-please opens a clean release PR after this merges.

…nd 0.0.11

Two manual `## [Unreleased]` sections existed in CHANGELOG.md:

- One between `[0.0.11]` and `[0.0.10]` whose entries (Homebrew tap publish job,
  npm publish job) already shipped in 0.0.10 and 0.0.11. Documented in the 0.0.11
  Bug Fixes block (#272).
- One at the bottom of the file dating to the 0.0.2 era. Every line in that block
  has been incorporated into a versioned section above (e.g. e2e matrix and
  baseline/rhythm in 0.0.2, x86_64-apple-darwin drop in 0.0.10, etc.).

Both blocks were stale. release-please (release-type: simple) does not consume
or maintain `[Unreleased]`; it generates new `## [x.y.z]` sections from
conventional commit messages on `main` at release time. Keeping an empty
placeholder would invite hand edits, which the file header already forbids.

Closes audit finding H18 from the public-surface readiness audit.
@github-actions

github-actions Bot commented May 7, 2026

Copy link
Copy Markdown
Contributor

That confirms the current main is at 0.0.11 — the PR's diff correctly bumps everything to 0.0.12. The output matches the diff already verified.


PR #286chore(main): release 0.0.12

Type: Release-please generated release PR
Files changed: .release-please-manifest.json, CHANGELOG.md, Cargo.toml (root only)

Review checklist

1. Determinism invariants — No Rust code changed. N/A.

2. Workspace layering — No dependency changes. N/A.

3. Error handling — No library code changed. N/A.

4. Test coverage — No new APIs. N/A.

5. Documentation / CHANGELOG accuracy — Checked changelog entries against visible git history. All referenced PRs (#276, #277, #278, #279, #280, #281, #282, #284, #285) are accounted for. chore/ci commits (#274, #275) are correctly excluded per release-please Conventional Commits convention.

Version consistency

  • Cargo.toml:25 — workspace version: 0.0.110.0.12
  • Cargo.toml:39–44 — all six internal dep constraints bumped uniformly ✓
  • All individual crates use version.workspace = true — no per-crate bumps needed ✓
  • .release-please-manifest.json updated to 0.0.12

Punch list

None. This is a purely mechanical release-please PR with no logic changes.


Verdict: APPROVE

@aram-devdocs
aram-devdocs merged commit a566734 into main May 8, 2026
17 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant