#release #please #semver #conventional #commits

app release-plz

Update version and changelog based on semantic versioning and conventional commits

115 releases

new 0.3.48 Feb 25, 2024
0.3.42 Jan 26, 2024
0.3.38 Dec 30, 2023
0.3.30 Nov 8, 2023
0.2.1 Mar 30, 2022

#16 in Development tools

Download history 174/week @ 2023-11-04 68/week @ 2023-11-11 46/week @ 2023-11-18 253/week @ 2023-11-25 470/week @ 2023-12-02 260/week @ 2023-12-09 255/week @ 2023-12-16 249/week @ 2023-12-23 215/week @ 2023-12-30 54/week @ 2024-01-06 85/week @ 2024-01-13 218/week @ 2024-01-20 273/week @ 2024-01-27 113/week @ 2024-02-03 546/week @ 2024-02-10 2007/week @ 2024-02-17

2,970 downloads per month

MIT/Apache

340KB
8K SLoC

release-plz-logo

Crates.io CI Docker

Release-plz helps you release your Rust packages by automating:

  • CHANGELOG generation (with git-cliff).
  • Creation of GitHub/Gitea releases.
  • Publishing to a cargo registry (crates.io by default).
  • Version bumps in Cargo.toml.

Release-plz updates your packages with a release Pull Request based on:

🤔 What's a Release PR?

Release-plz maintains Release PRs, keeping them up-to-date as you merge additional commits. When you're ready to create a release, simply merge the release PR.

pr

When you merge the Release PR (or when you edit the Cargo.toml versions by yourself), release-plz:

  • Creates a git tag named <package_name>-v<version> (e.g. tokio-v1.8.1).
  • Publishes the package to the cargo registry by running cargo publish.
  • Publishes a GitHub/Gitea release based on the git tag.

📚 Docs

Learn how to use release-plz in the docs.

🤖 Running release-plz

There are two ways to run release-plz:

  • GitHub Action: Run Release-plz from CI. The action both updates and releases your packages.
  • CLI: Run release-plz from your terminal or other CI systems (Gitea supported).

💖 Users

Here you can find the public repositories using the release-plz GitHub action in CI:

🌓 Similar projects

  • release-please: release-plz is inspired by release-please, but instead of determining the next versions based on git tags, release-plz compares local packages with the ones published in the cargo registry. Plus, release-plz doesn't need any configuration and is optimized for Rust projects.
  • cargo-smart-release: Fearlessly release workspace crates and with beautiful semi-handcrafted changelogs.

📽️ RustLab 23 talk

In RustLab 23, I showed how release-plz simplifies releasing Rust packages, why I created it, and what lessons I learned:

RustLab 23 talk

🙏 Credits

Parts of the codebase are inspired by:


Licensed under either of Apache License, Version 2.0 or MIT license at your option.
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

~109MB
~2M SLoC