Skip to content

Keep an Unreleased section at the top of the changelog - #16

Merged
NingyuSUN merged 1 commit into
mainfrom
changelog-unreleased
Sep 28, 2026
Merged

NingyuSUN merged 1 commit into
mainfrom
changelog-unreleased

Conversation

@NingyuSUN

Copy link
Copy Markdown
Owner

Releasing 0.7.0 renamed the Unreleased changelog section. Open PRs that added notes there (#12, #13, #14) now either conflict or would silently put their notes inside the already-published 0.7.0 section.

  • Add a permanent ## Unreleased section at the top of CHANGELOG.md.
  • CONTRIBUTING and the PR template now say to add notes under ## Unreleased and never edit a released section; the release steps say to rename it and open a fresh one.
  • New test: the first changelog section must be ## Unreleased, so a release can't forget it again.
  • The release workflow's notes extraction still finds the 0.7.0 section (checked).

Releasing 0.7.0 renamed the Unreleased section, so open pull requests that
had added notes there now either conflict or silently place their notes in
the published 0.7.0 section. Keep a permanent "## Unreleased" on top, make
CONTRIBUTING, the PR template and the release steps say so, and test that
the first changelog section is always Unreleased.
@NingyuSUN
NingyuSUN merged commit 4b0cde3 into main Sep 28, 2026
9 checks passed
@NingyuSUN
NingyuSUN deleted the changelog-unreleased branch October 6, 2026 02:41
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