README.md

cargo-semver-bump

🚧 WORK IN PROGRESS 🚧

This tool is still in early ydevelopment and not ready for production use. Breaking changes may occur at any time.

cargo-semver-bump is a tool to automatically bump the version of your Rust crate based on the Conventional Commits specification and breaking changes detected by cargo-semver-checks.

Installation

From crates.io

cargo install cargo-semver-bump --locked

Arch Linux

cargo-semver-bump can be installed from the AUR using an AUR helper. For example:

paru -S cargo-semver-bump

Usage

Just run the following command in your project directory:

cargo semver-bump

More options are available:

$ cargo semver-bump --help

Usage: cargo semver-bump [OPTIONS]

Options:
  -d, --dry-run      Run without making any changes
  -p, --path <PATH>  Path to project [default: ./]
  -v, --verbose      Enable verbose output
  -h, --help         Print help
  -V, --version      Print version

Limitations

• Only works with Git repositories
• Only works with Cargo.toml files in the root of the repository
• Limitations of cargo-semver-checks

Contributing

See the contributing guidelines for more information.

License

This code is licensed under either of

• MIT License
• Apache-2.0 License

at your option.