Document the new action inputs. (#52)

This commit is contained in:
Predrag Gruevski 2023-06-06 15:35:53 -04:00 committed by GitHub
parent 050645d214
commit e275dda72e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 8 deletions

View file

@ -13,18 +13,19 @@ inputs:
manifest-path: manifest-path:
description: '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.' description: '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.'
required: false required: false
feature-group:
description: 'Override the feature group used for semver-checking, for example if you only want to check with default features.'
required: false
features:
description: 'Comma-separated list of crate features to explicitly include when semver-checking.'
required: false
verbose: verbose:
description: 'Enables verbose output of `cargo-semver-checks`.' description: 'Enables verbose output of `cargo-semver-checks`.'
type: boolean
required: true required: true
default: false default: 'false'
release-type: release-type:
description: 'Sets the release type instead of deriving it from the version number specified in the `Cargo.toml` file.' description: 'Sets the release type instead of deriving it from the version number specified in the `Cargo.toml` file.'
required: false required: false
options:
- patch
- minor
- major
rust-toolchain: rust-toolchain:
description: '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.' description: '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.'
default: 'stable' default: 'stable'

2
dist/index.js vendored

File diff suppressed because one or more lines are too long

View file

@ -23,7 +23,7 @@ function getCheckReleaseArguments(): string[] {
optionIfValueProvided("--manifest-path", rustCore.input.getInput("manifest-path")), optionIfValueProvided("--manifest-path", rustCore.input.getInput("manifest-path")),
optionIfValueProvided("--release-type", rustCore.input.getInput("release-type")), optionIfValueProvided("--release-type", rustCore.input.getInput("release-type")),
getFeatureGroup(rustCore.input.getInput("feature-group")), getFeatureGroup(rustCore.input.getInput("feature-group")),
optionFromList("--feature", rustCore.input.getInputList("feature")), optionFromList("--features", rustCore.input.getInputList("features")),
rustCore.input.getInputBool("verbose") ? ["--verbose"] : [], rustCore.input.getInputBool("verbose") ? ["--verbose"] : [],
].flat(); ].flat();
} }