cargo-breaking
Compares a Rust crate's public API between branches, detects breaking changes, and suggests the next semantic version.
What is cargo-breaking?
cargo-breaking is a Rust command-line tool that compares a crate's public API between two different Git branches or commits. It detects breaking changes, additions, and modifications, then suggests the next semantic version (e.g., 3.0.0) based on the impact of those changes. This helps Rust developers maintain API stability and adhere to semantic versioning principles.
Rust crate maintainers and library authors who need to manage versioning and ensure backward compatibility when publishing updates.
It automates the tedious process of manually reviewing API changes for semver compliance, providing clear, actionable output that reduces human error and streamlines release workflows.
Overview
cargo-breaking is a Rust tool that analyzes changes to a crate's public API between different Git branches or commits. It identifies additions, removals, and modifications, then recommends the appropriate next version number based on semantic versioning rules. This helps maintainers ensure API compatibility and communicate changes effectively to downstream users.
Key Features
- API Comparison — Compares public API signatures between two Git references (branches, tags, or commits).
- Breaking Change Detection — Identifies function, struct, enum, and method changes that affect semver.
- Version Suggestion — Recommends the next version (major, minor, patch) according to semver based on detected changes.
- Change Reporting — Outputs a clear diff-like summary of what was added (+), removed (-), or changed (≠).
Philosophy
cargo-breaking focuses on detecting most breaking changes while deliberately ignoring subtle, hard-to-detect ones to maintain practicality and reduce noise in versioning decisions.
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
