release-plz/release-plz

Update version and changelog based on semantic versioning and conventional commits

Trust Signals

name	description	required	default
command	The release-plz command to run. Accepted values: `release-pr`, `release`. If unspecified, this action runs both these commands.	no	—
registry	Registry where the packages are stored. The registry name needs to be present in the Cargo config. If unspecified, crates.io is used.	no	—
config	Config file location. If not present, the default 'release-plz.toml' is used.	no	—
forge	Git forge/backend. Valid values: 'github', 'gitea'	no	github
backend	Supported for backward compatibility. Use 'forge' instead.	no	github
manifest_path	Path to the Cargo.toml of the project you want to update. If not provided, release-plz will use the Cargo.toml of the root directory. Both Cargo workspaces and single packages are supported.	no	—
project_manifest	Deprecated. Use `manifest_path` instead.	no	—
version	Release-plz version to use. (Default: `0.3.160`).	no	0.3.160
token	Token used to publish to the cargo registry	no	—
verbose	Print module and source location in logs.	no	—
dry_run	Add the `--dry-run` flag to the `release` command. If the input `command` is left unspecified (and so both `release` and `release-pr` are ran), the `--dry-run` flag is only added to the `release` command (the flag isn't added to the `release-pr` command). Useful if you're only interested in whether or not a release (pr) would be created.	no	—

name	description
prs	The release PRs opened by release-plz. (Not useful for now. Use `pr` instead)
pr	The release PR opened by release-plz.
releases	The JSON output of the `release` command.
prs_created	Whether release-plz created any release PR.
releases_created	Whether release-plz released any package.