prepare-release
Prepare a new release by updating CHANGELOG.md with changes since the last tag and bumping version numbers in pyproject.toml and ui/package.json
When & Why to Use This Skill
This Claude skill automates the software release preparation process by intelligently updating CHANGELOG.md based on recent git commits and synchronizing version bumps across multiple configuration files like pyproject.toml and package.json. It streamlines the transition from development to deployment while ensuring adherence to semantic versioning standards and maintaining clear project documentation.
Use Cases
- Automated Release Notes: Generate comprehensive changelogs by analyzing git commit history since the last tag, automatically categorizing entries into breaking changes, new features, and internal improvements.
- Multi-stack Version Synchronization: Simultaneously update version strings in both backend (pyproject.toml) and frontend (package.json) environments to ensure project-wide version consistency.
- Standardized Semantic Versioning: Implement consistent SemVer logic (Major.Minor.Patch) across the codebase to reduce human error during the release cycle.
| name | prepare-release |
|---|---|
| description | Prepare a new release by updating CHANGELOG.md with changes since the last tag and bumping version numbers in pyproject.toml and ui/package.json |
Prepare Release
When preparing a release, follow these steps:
1. Fetch tags and identify the last release
git fetch --tags
git tag --sort=-creatordate | head -5
2. Get commits since the last release
git log --oneline <last-tag>..HEAD
3. Read current files
Read these files to understand current state:
CHANGELOG.md- to understand the format and existing entriespyproject.toml- to get current versionui/package.json- to get current UI version
4. Update CHANGELOG.md
- Add a new version section at the top (below the
# Changelogheader) - Organize changes into categories:
- Breaking Changes - API changes that require user action
- New Features - New functionality
- Internal Improvements - Refactoring, tests, tooling
- Use bold headers for each change group
- Use bullet points for details
- If there was an "Unreleased" section, rename it to the previous version
5. Bump versions
Update the version string in:
pyproject.toml- theversionfield under[project]ui/package.json- the"version"field
Use semantic versioning:
- Patch (0.0.x) for bug fixes
- Minor (0.x.0) for new features
- Major (x.0.0) for breaking changes
6. Summary
After completing, summarize what was updated:
- New version number
- Key changes added to changelog
- Files modified