#cargo

app cargo-release

Cargo subcommand for you to smooth your release process

73 releases (17 breaking)

new 0.18.3 Oct 27, 2021
0.17.1 Aug 25, 2021
0.16.2 Jul 15, 2021
0.13.11 Mar 25, 2021
0.2.1 Mar 17, 2016

#51 in Cargo plugins

Download history 381/week @ 2021-07-07 450/week @ 2021-07-14 301/week @ 2021-07-21 503/week @ 2021-07-28 524/week @ 2021-08-04 378/week @ 2021-08-11 463/week @ 2021-08-18 458/week @ 2021-08-25 468/week @ 2021-09-01 356/week @ 2021-09-08 214/week @ 2021-09-15 299/week @ 2021-09-22 214/week @ 2021-09-29 523/week @ 2021-10-06 421/week @ 2021-10-13 264/week @ 2021-10-20

1,681 downloads per month
Used in less than 7 crates

MIT/Apache

115KB
3K 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
    • Updating changelogs
    • Update tags in Dockerfiles
  • Pre-release hook for extra customization, including

Install

Current release: 0.18.3

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.

License

Licensed under either of

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

~19MB
~441K SLoC