docs: add release process with CalVer versioning and PyPI publishing#27
Merged
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3668883e40
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Add comprehensive release process documentation and GitHub Actions workflow for automated PyPI publishing using trusted publishers (OIDC). - Add RELEASE.md with CalVer versioning scheme (YYYY.MM.MICRO) - Add step-by-step release checklist and rollback procedures - Add .github/workflows/release.yml for automated publishing - Configure TestPyPI and PyPI trusted publisher workflow - Update version from 0.1.0 to 2025.1.0 (first CalVer version) - Update CHANGELOG.md to reference CalVer instead of SemVer Closes #26 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
The name "plait" is unavailable on PyPI, so we use "pyplait" as the package name while keeping "plait" as the Python module name. - pip install pyplait - import plait 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Update README.md and docs/getting-started.md to reflect that the package is published as 'pyplait' on PyPI while imported as 'plait'. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Use importlib.metadata.version() to dynamically get the version from the installed package, avoiding the need to update two places on each release. Addresses reviewer feedback about __version__ being out of sync with pyproject.toml. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
eric-tramel
force-pushed
the
feat/release-process
branch
from
c0aeaf2 to
b926bcf
Compare
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
Add comprehensive release process documentation and GitHub Actions workflow for automated PyPI publishing using trusted publishers (OIDC).
RELEASE.mdwith CalVer versioning scheme (YYYY.MM.MICRO).github/workflows/release.ymlfor automated TestPyPI and PyPI publishing0.1.0to2025.1.0(first CalVer version)Changes
RELEASE.md: Complete release process documentation including:
YYYY.MM.MICRO).github/workflows/release.yml: Automated release workflow that:
v*)hatchlingpyproject.toml: Update version to first CalVer version
2025.1.0CHANGELOG.md: Update to reference CalVer instead of SemVer
Testing
make ci)Related
🤖 Generated with Claude Code