Skip to content

SemRels/updater-cargo

updater-cargo

Updates the Rust crate version in Cargo.toml.

This plugin is distributed as the standalone Go binary semrel-plugin-updater-cargo. Semrel executes the binary as a subprocess, provides plugin configuration through SEMREL_PLUGIN_* environment variables, provides release context through SEMREL_* environment variables, reads standard output, and treats exit code 0 as success and any non-zero exit code as failure. Install the binary in ~/.semrel/plugins/ or anywhere on your $PATH.

Installation

go install github.com/SemRels/updater-cargo/cmd/plugin@latest

Configuration

plugins:
  - name: updater-cargo
    path: ~/.semrel/plugins/semrel-plugin-updater-cargo
    env:
      SEMREL_PLUGIN_FILE: "Cargo.toml"

SEMREL_PLUGIN_* variables

Name Required Description Default
SEMREL_PLUGIN_FILE Optional Path to the Cargo manifest to update. Cargo.toml

SEMREL_* release context used

Variable Description
SEMREL_VERSION Resolved release version for the current run.
SEMREL_NEXT_VERSION Next version computed by semrel for the release.
SEMREL_DRY_RUN Whether semrel is running in dry-run mode.

Example behavior

The plugin rewrites the crate version in the selected manifest file to the next release version. In dry-run mode it reports the change without writing the file.

License

Apache-2.0