What problem does it solve?
Prepare a crate or project for release with a clear, reviewable process that detects breaking API changes, drafts user-facing changelogs, suggests semantic version bumps, and verifies documentation and packaging before tagging.
Core Features & Use Cases
- Breaking-change detection: Integrates cargo-semver-checks for Rust and provides manual guidance for Python/JS to identify public API changes.
- Version bump recommendation: Recommends patch/minor/major bumps based on gathered changes and presents rationale for user approval.
- Changelog generation & docs verification: Drafts user-facing changelog entries from commits, checks README/API docs, and ensures version consistency.
- Workspace ordering: Computes multi-crate release order from dependency graphs and provides a safe checklist before tagging.
- Use Case: Use when preparing a Rust workspace release to detect regressions, produce a migration note for breaking changes, and tag a coordinated multi-crate release.
Quick Start
Run release-prep for the crate or workspace name to generate a suggested version bump and a draft changelog for your review.
