Skip to content

Name the release notes of the next release unreleased.md - #28

Merged
ru551n merged 1 commit into
VUnit:mainfrom
ru551n:release-notes-unreleased
Oct 14, 2026
Merged

ru551n merged 1 commit into
VUnit:mainfrom
ru551n:release-notes-unreleased

Conversation

@ru551n

@ru551n ru551n commented Oct 14, 2026

Copy link
Copy Markdown
Collaborator

Names the release notes of the next release release_notes/unreleased.md instead of release_notes/0.2.0.md, so the notes don't name a version before it has been decided.

  • Releasing: the commit that bumps the version in pyproject.toml renames unreleased.md to release_notes/<version>.md. The release workflow publishes that file, as before.

  • Fail early: tools/release.py validate --tag vX.Y.Z fails while release_notes/unreleased.md still exists, so a tag can't publish a release without its notes. Without --tag (the workflow_dispatch rehearsal) it doesn't check, since the file still exists while a release is rehearsed.

    .../release_notes/unreleased.md still exists. Rename it to release_notes/0.2.0.md in the commit bumping the version.
    
  • Docs: the release notes page lists unreleased.md first, titled "Unreleased", then the releases, newest first. It no longer compares against the version in pyproject.toml.

  • publish.yml: the comment on the release step mentions the rename.

Open PRs

#15, #16, #18, #21 and #26 add entries to release_notes/0.2.0.md. When rebased, those entries move to release_notes/unreleased.md.

Tests

  • validate --tag v0.1.0 fails with the message above, and validate without a tag passes.
  • The docs build with -W, with "Unreleased" then "0.1.0".
  • ruff and the license header check pass.

🤖 Generated with Claude Code

release_notes/0.2.0.md becomes release_notes/unreleased.md, so the notes of the next
release don't name a version before it is decided. The commit bumping the version
renames the file to release_notes/<version>.md, which the release workflow publishes,
and tools/release.py validate --tag fails while unreleased.md still exists. The docs
list unreleased.md first, titled Unreleased.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ru551n
ru551n merged commit b35cbc8 into VUnit:main Oct 14, 2026
27 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