Skip to main content

Input variables

The GitHub action accepts the following input variables:

  • command: The release-plz command to run. Accepted values: release-pr, release. (By default it runs both commands).
  • registry: Registry where the packages are stored. The registry name needs to be present in the Cargo config. If unspecified, the publish field of the package manifest is used. If the publish field is empty, crates.io is used.
  • manifest_path: Path to the Cargo.toml of the project you want to update. Both Cargo workspaces and single packages are supported. (Defaults to the root directory).
  • version: Release-plz version to use. E.g. 0.3.70. (Default: latest version).
  • config: Release-plz config file location. (Defaults to release-plz.toml or .release-plz.toml).
  • token: Token used to publish to the cargo registry. Override the CARGO_REGISTRY_TOKEN environment variable, or the CARGO_REGISTRIES_<NAME>_TOKEN environment variable, used for registry specified in the registry input variable.
  • forge (previously backend): Git forge. Valid values: github, gitea, gitlab. (Defaults to github).
  • verbose: Print module and source location in logs. I.e. adds the -v flag to the command. (Defaults to false).
  • 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.

You can specify the input variables by using the with keyword. For example:

steps:
  - ...
  - name: Run release-plz
    uses: release-plz/action@v0.5
    # Input variables
    with:
      command: release-pr
      registry: my-registry
      manifest_path: rust-crates/my-crate/Cargo.toml
      version: 0.3.70
      dry_run: true
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}