docs: add release-process checklist + PyPI Trusted Publisher setup#5
Merged
Conversation
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Captures the one-time setup (GitHub pypi environment + PyPI Trusted Publisher binding + branch protection) and the per-release checklist the maintainer should run through before tagging. The pypi environment was already created via API; the PyPI-side Trusted Publisher binding still has to be added manually on pypi.org (it's not in git — see step 2 in the doc). Once that's done, tagging vX.Y.Z auto-fires the release workflow end-to-end (build → GitHub Release → PyPI publish). Also documents common failure modes (yank, hotfix, redo-on-CI-red) and the rationale for Trusted Publishing over a long-lived API token.
arnav2
added a commit
that referenced
this pull request
May 11, 2026
* docs(readme): make hero banner full width Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs: add release-process checklist for v0.2.0+ Captures the one-time setup (GitHub pypi environment + PyPI Trusted Publisher binding + branch protection) and the per-release checklist the maintainer should run through before tagging. The pypi environment was already created via API; the PyPI-side Trusted Publisher binding still has to be added manually on pypi.org (it's not in git — see step 2 in the doc). Once that's done, tagging vX.Y.Z auto-fires the release workflow end-to-end (build → GitHub Release → PyPI publish). Also documents common failure modes (yank, hotfix, redo-on-CI-red) and the rationale for Trusted Publishing over a long-lived API token. --------- Co-authored-by: Claude Opus 4.7 (1M context) <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
1 participant
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.
Summary
Captures the one-time release infrastructure setup so the next maintainer doesn't have to reconstruct it from scratch. The release.yml workflow (already in main) assumes three things exist that aren't fully captured in code:
Without (2), tagging `v0.2.0` will create the GitHub Release fine but the PyPI publish step will fail at the OIDC handshake.
Test plan
Why this is a separate PR from #4
The v0.2.0 release PR (#4) ships the parser changes + benchmark + version bump. This PR is just docs — separating them keeps the release PR reviewable and lets this checklist land first so the maintainer has it in hand when tagging.
🤖 Generated with Claude Code