step-security/cargo-semver-checks
Ensure the public API in your Rust crate follows semantic versioning
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| package | Comma-separated list of the packages whose API to check for semver (in Package Id Specification format, see https://doc.rust-lang.org/cargo/reference/pkgid-spec.html for reference). If not set, all packages defined in the Cargo.toml file are processed. | no | — |
| exclude | Comma-separated list of the packages that will be excluded from being processed. Has effect only if the input `package` is not specified. | no | — |
| manifest-path | Path to Cargo.toml of crate or workspace to check. If not specified, the action assumes the manifest is under the default `GITHUB_WORKSPACE` path. | no | — |
| feature-group | Override the feature group used for semver-checking, for example if you only want to check with default features. | no | — |
| features | Comma-separated list of crate features to explicitly include when semver-checking. | no | — |
| verbose | Enables verbose output of `cargo-semver-checks`. | yes | false |
| release-type | Sets the release type instead of deriving it from the version number specified in the `Cargo.toml` file. | no | — |
| rust-toolchain | Rust toolchain name to use, e.g. `stable`, `nightly` or `1.68.0`. It will be installed if necessary and used regardless of local overrides and the `rust-toolchain.toml` file. However, if the input is set to `manual`, the action assumes some Rust toolchain is already installed and uses the default one. | — | stable |
| shared-key | A cache key that will be used instead of the automatic key based on the name of the GitHub job and values of the inputs `package`, `exclude` and `manifest-path`. Might be provided e.g. to share the cache between the jobs. | no | "" |
| prefix-key | Additional prefix of the cache key, can be set to start a new cache manually. | no | — |
| github-token | The `GITHUB_TOKEN` secret used to download precompiled binaries from GitHub API. If not specified, the automatic GitHub token provided to the workflow will be used. | no | ${{ github.token }} |
| baseline-version | TODO | no | — |
| baseline-rev | TODO | no | — |
Outputs
no outputs