name: release description: Guide the release procedure for namingpaper - version bump, commit, GitHub release, and PyPI publish. metadata: author: namingpaper version: "1.0"
Release Procedure
Follow these steps to release a new version of namingpaper. The user should provide the version number (X.Y.Z).
Steps
- Bump version in both
pyproject.tomlandsrc/namingpaper/__init__.py - Commit and push:
git add -A && git commit -m "Bump version to X.Y.Z" && git push origin main - Create GitHub release:
gh release create vX.Y.Z --title "vX.Y.Z" --prerelease --notes "..."- Drop
--prereleasefor stable releases
- Drop
- Build and publish to PyPI:
uv build source .env # contains UV_PUBLISH_TOKEN uv publish --token "$UV_PUBLISH_TOKEN" - Clean old dists if needed:
rm -rf dist/before building to avoid uploading stale files
Important
- Always confirm the version number with the user before starting.
- Ask whether this is a stable or prerelease before creating the GitHub release.