cargo-release
| Crates.io | cargo-release |
| lib.rs | cargo-release |
| version | |
| source | src |
| created_at | 2016-03-09 05:16:14.617315 |
| updated_at | 2024-12-12 21:42:23.748208 |
| description | Cargo subcommand for you to smooth your release process. |
| homepage | |
| repository | https://github.com/crate-ci/cargo-release |
| max_upload_size | |
| id | 4408 |
| Cargo.toml error: | TOML parse error at line 28, column 1 | 28 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
Ed Page (epage)
documentation
README
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,--excludeand--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.25.14
$ 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
-vto get more details - Speed up dry-run by skipping
cargo-publishs verify step with--no-verify
Once you are ready, pass the --execute flag.
Related tools
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
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
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.