Document release process, harden publish CI, fix stale docs badge#46
Merged
Conversation
Add a Release Process section to CLAUDE.md capturing the branch/version model we standardized on: feature branches touch only CHANGELOG's [Unreleased] section, and a dedicated short-lived release/X.Y.Z branch bumps the version and finalizes the changelog before a GitHub Release triggers publishing. Also replace the hardcoded "Current version" line with a pointer to pyproject (the single source of truth). Harden publish-to-pypi.yml: split into test -> publish (needs: test), running the suite and verifying the release tag matches pyproject before uploading. The workflow previously published untested and without any tag/version check. Fix docs/index.rst PyPI badge, which was a static image pinned to a stale 0.0.14; use the dynamic shields.io endpoint like README so it tracks PyPI automatically. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
OwenYou
approved these changes
Jul 8, 2026
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
2 participants
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.
Add a Release Process section to CLAUDE.md capturing the branch/version model we standardized on: feature branches touch only CHANGELOG's [Unreleased] section, and a dedicated short-lived release/X.Y.Z branch bumps the version and finalizes the changelog before a GitHub Release triggers publishing. Also replace the hardcoded "Current version" line with a pointer to pyproject (the single source of truth).
Harden publish-to-pypi.yml: split into test -> publish (needs: test), running the suite and verifying the release tag matches pyproject before uploading. The workflow previously published untested and without any tag/version check.
Fix docs/index.rst PyPI badge, which was a static image pinned to a stale 0.0.14; use the dynamic shields.io endpoint like README so it tracks PyPI automatically.