release
This skill should be used when the user asks to "release", "publish", "bump version", "create a release", "prepare release", or wants to publish a new version to PyPI.
When & Why to Use This Skill
This Claude skill automates the end-to-end software release lifecycle, enabling developers to seamlessly manage version bumping, synchronize configuration files across different ecosystems (like Python and Rust), and execute Git-based deployment workflows. By streamlining the preparation of release commits and tags, it ensures consistent and error-free publishing to platforms like PyPI and triggers CI/CD pipelines effectively.
Use Cases
- Automated Version Management: Effortlessly bump semantic versions (patch, minor, major) across multiple project files such as pyproject.toml and Cargo.toml to maintain consistency.
- Changelog Automation: Automatically generate and update CHANGELOG.md entries with new version headers and change descriptions to keep project history well-documented.
- Git Release Orchestration: Streamline the process of staging release-related changes, creating standardized 'chore: release' commits, and pushing Git tags to trigger automated build workflows.
- PyPI Publishing Readiness: Ensure all version-sensitive files are perfectly synchronized before a release to prevent common deployment failures like 'file already exists' errors.
| name | release |
|---|---|
| description | This skill should be used when the user asks to "release", "publish", "bump version", "create a release", "prepare release", or wants to publish a new version to PyPI. |
| version | 1.0.0 |
Release Skill
This skill guides the release process for rtest, ensuring all version files are updated consistently.
When This Skill Applies
Use this skill when the user wants to:
- Publish a new version to PyPI
- Bump the version number
- Create a release
- Prepare a release commit and tag
Release Process
Step 1: Determine Version Number
Ask the user for the new version number if not provided. The current version can be found in pyproject.toml.
For semantic versioning:
- patch (0.0.X): Bug fixes, minor changes
- minor (0.X.0): New features, backwards compatible
- major (X.0.0): Breaking changes
Step 2: Update Version Files
Update the version in both files (they must stay in sync):
- pyproject.toml - Update
version = "X.X.X"under[project] - Cargo.toml - Update
version = "X.X.X"under[package]
Step 3: Update CHANGELOG.md
Add a new section after ## [Unreleased]:
## [X.X.X] - YYYY-MM-DD
### Added/Changed/Fixed
- Description of changes
Ask the user for a summary of changes if not provided.
Step 4: Create Release Commit
Stage and commit all changes:
git add pyproject.toml Cargo.toml CHANGELOG.md
git commit -m "chore: release vX.X.X"
Step 5: Create and Push Tag
git tag vX.X.X
git push origin main --tags
Important Notes
- Always update BOTH pyproject.toml AND Cargo.toml - missing one will cause the PyPI release to fail with "file already exists" error
- The tag push triggers the GitHub Actions release workflow which builds and publishes to PyPI
- Use conventional commit format:
chore: release vX.X.X