obi1kenobi/cargo-semver-checks

Ensure the public API in your Rust crate follows semantic versioning

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
packageComma-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
excludeComma-separated list of the packages that will be excluded from being processed. Has effect only if the input `package` is not specified.no
manifest-pathPath 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-groupOverride the feature group used for semver-checking, for example if you only want to check with default features.no
featuresComma-separated list of crate features to explicitly include when semver-checking.no
verboseEnables verbose output of `cargo-semver-checks`.yesfalse
release-typeSets the release type instead of deriving it from the version number specified in the `Cargo.toml` file.no
rust-toolchainRust 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
rust-targetRust target to build for, e.g. `x86_64-pc-windows-msvc` or `aarch64-apple-darwin`. It will be installed if necessary and used regardless of the `.cargo/config.toml` file. However, if `rust-toolchain` is set to `manual`, the action assumes the target is already installed.""
shared-keyA 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-keyAdditional prefix of the cache key, can be set to start a new cache manually.no
github-tokenThe `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-versionVersion from registry to look up as a baselineno""
baseline-revGit revision, branch, or tag to use as a baselineno""
baseline-rootDirectory containing baseline crate sourceno""
namedescription
rustc-versionThe rustc version used in the cargo-semver-checks run.