Repository navigation
Name the release notes of the next release unreleased.md - #28
Merged
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Names the release notes of the next release
release_notes/unreleased.mdinstead ofrelease_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.tomlrenamesunreleased.mdtorelease_notes/<version>.md. The release workflow publishes that file, as before.Fail early:
tools/release.py validate --tag vX.Y.Zfails whilerelease_notes/unreleased.mdstill exists, so a tag can't publish a release without its notes. Without--tag(theworkflow_dispatchrehearsal) it doesn't check, since the file still exists while a release is rehearsed.Docs: the release notes page lists
unreleased.mdfirst, titled "Unreleased", then the releases, newest first. It no longer compares against the version inpyproject.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 torelease_notes/unreleased.md.Tests
validate --tag v0.1.0fails with the message above, andvalidatewithout a tag passes.-W, with "Unreleased" then "0.1.0".🤖 Generated with Claude Code