
[](https://crates.io/crates/release-plz)
[](https://github.com/MarcoIeni/release-plz/actions)
[](https://hub.docker.com/r/marcoieni/release-plz)
Release-plz updates the versions and changelogs of your rust packages, by analyzing your git history,
based on [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/):
- `release-plz update` updates your project locally, without committing any change.
- `release-plz release-pr` opens a GitHub Pull Request.
Once the changes are merged to the main branch, you can use
`release-plz release` to publish the new versions of the packages.
## Docs
Learn how to use release-plz in the mdbook [docs](https://marcoieni.github.io/release-plz/).
## Users
[This](https://cs.github.com/?scopeName=All+repos&scope=&q=path%3A*.yml+OR+path%3A*.yml+MarcoIeni%2Frelease-plz)
GitHub search shows the public repositories using release-plz in CI.
## Similar projects
- [release-please](https://github.com/googleapis/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.
- [cargo smart-release](https://github.com/Byron/gitoxide/tree/main/cargo-smart-release):
Fearlessly release workspace crates and with beautiful semi-handcrafted changelogs.
## License
Licensed under either of
* Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license
([LICENSE-MIT](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.
See [CONTRIBUTING.md](CONTRIBUTING.md).
## Credits
Parts of the codebase are inspired by:
- [cargo-workspaces](https://github.com/pksunkara/cargo-workspaces)
- [cargo-release](https://github.com/crate-ci/cargo-release)
- [cargo-edit](https://github.com/killercup/cargo-edit)
- [git-cliff](https://github.com/orhun/git-cliff)