#cargo-subcommand #cargo-cargo

bin+lib cargo-release

Cargo subcommand for you to smooth your release process

121 releases

0.25.5 Feb 8, 2024
0.25.1 Dec 27, 2023
0.25.0 Nov 1, 2023
0.24.11 Jun 26, 2023
0.2.1 Mar 17, 2016

#38 in Cargo plugins

Download history 1288/week @ 2023-11-02 1305/week @ 2023-11-09 1181/week @ 2023-11-16 1260/week @ 2023-11-23 1141/week @ 2023-11-30 1102/week @ 2023-12-07 1124/week @ 2023-12-14 997/week @ 2023-12-21 1138/week @ 2023-12-28 1459/week @ 2024-01-04 1733/week @ 2024-01-11 1353/week @ 2024-01-18 1074/week @ 2024-01-25 1426/week @ 2024-02-01 1649/week @ 2024-02-08 1518/week @ 2024-02-15

5,842 downloads per month
Used in 15 crates

MIT/Apache

220KB
5.5K SLoC

cargo release

Features

  • Ensure you are in a good state for release, including:
    • Right branch
    • Up-to-date with remote
    • Clean tree
  • Supports workspaces using cargo's native flags, like --workspace, --exclude and --package
    • Updates dependent crates in workspace when changing version
    • Change detection to help guide in what crates might not need a release
    • Optionally share commits
  • Handles cargo publish, tagging, and pushing
  • Pre-release search and replace for custom version updates, including
  • Pre-release hook for extra customization, including

Install

Current release: 0.25.5

$ cargo install cargo-release

Usage

$ cargo release [level]
  • See the reference for more on level, other CLI arguments, and configuration file format.
  • See also the FAQ for help in figuring out how to adapt cargo-release to your workflow.

Prerequisite

  • Your project should be managed by git.

Dry run

By default, cargo-release runs in dry-run mode so you can safely run it and verify what it will do.

  • Increase the logging level with each additional -v to get more details
  • Speed up dry-run by skipping cargo-publishs verify step with --no-verify

Once you are ready, pass the --execute flag.

Semver Compatibility

cargo-release's versioning tracks compatibility for the binaries, not the API. We upload to crates.io to distribute the binary. If using this as a library, be sure to pin the version with a = version requirement operator.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~26–43MB
~766K SLoC