Move release procedure out of the READMEs into RELEASING.md - #7
Merged
Conversation
The READMEs are the PyPI long description; release/vendoring steps are maintainer docs, not user docs. RELEASING.md also documents the full tag pipeline including the GitHub Release assets job added in #6. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SQbVkPEprK2ebcjck5ouUy
There was a problem hiding this comment.
Pull request overview
Moves maintainer-facing release documentation out of the READMEs (which are used as the PyPI long description) into a dedicated RELEASING.md, keeping the READMEs focused on end users while preserving the user-facing “Versions” section.
Changes:
- Add
RELEASING.mddocumenting the tag-based release pipeline, release steps, bundled server bump procedure, local build commands, and one-time PyPI/environment setup. - Replace the detailed “Releasing / bundled binaries” sections in
README.mdandREADME_JP.mdwith a short pointer toRELEASING.md.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| RELEASING.md | Introduces consolidated maintainer release and bundled-binary procedures. |
| README.md | Removes maintainer release section and links to RELEASING.md to keep PyPI description user-focused. |
| README_JP.md | Same as README.md, in Japanese. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+38
to
+39
| If publish fails transiently, fix and re-push the same tag — PyPI skips | ||
| files it already has, and the release job then attaches the assets. |
Per review: git rejects pushing an existing tag; the correct recovery for a transient publish failure is re-running the failed jobs from the Actions UI. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SQbVkPEprK2ebcjck5ouUy
| python scripts/vendor_binaries.py # fetch + verify all binaries | ||
| python -m build --wheel | ||
| python -m wheel tags --platform-tag manylinux_2_34_x86_64 --remove dist/*.whl | ||
| python -m build --sdist # remove binaries first for a clean sdist |
Per review: say where the vendored binaries live instead of 'remove binaries first'. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SQbVkPEprK2ebcjck5ouUy
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.
Summary
The READMEs double as the PyPI long description, but the "Releasing / bundled binaries" section is maintainer documentation — noise for
pip installusers.README.md/README_JP.mdwith a one-line pointer.Docs only — no code or workflow changes.
🤖 Generated with Claude Code
Generated by Claude Code