actions/cargo-semver-checks
actions/cargo-semver-checks
3
0
Fork 0
mirror of https://github.com/obi1kenobi/cargo-semver-checks-action.git synced 2024-11-25 17:39:33 +01:00
Code Issues Projects Activity Pipelines

Document manifest-path default behaviour

Browse source
This commit is contained in:
Mieszko Grodzicki 2023-02-28 10:35:44 +01:00 committed by Predrag Gruevski
parent 5fbde10d11
commit 3cf3a963be
2 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -17,7 +17,7 @@ Every argument is optional.
| Input | Description | Default | | Input | Description | Default |
|--------------------|-----------------------------------------------------------------------------------------------------------------------------------|---------| |--------------------|-----------------------------------------------------------------------------------------------------------------------------------|---------|
| `package` | The package 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 in the workspace are processed. | | | `package` | The package 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 in the workspace are processed. | |
| `manifest-path` | Path to Cargo.toml of crate or workspace to check. | | | `manifest-path` | Path to Cargo.toml of crate or workspace to check. By default, the action will assume it exists in the current directory. | |
| `verbose` | Enables verbose output of `cargo-semver-checks`. | `false` | | `verbose` | Enables verbose output of `cargo-semver-checks`. | `false` |
| `github-token` | The `GITHUB_TOKEN` secret used to download precompiled binaries from GitHub API. If not specified, the [automatic GitHub token](https://docs.github.com/en/actions/security-guides/automatic-token-authentication) provided to the workflow will be used. The token may be alternatively passed in an environment variable `GITHUB_TOKEN`. | | | `github-token` | The `GITHUB_TOKEN` secret used to download precompiled binaries from GitHub API. If not specified, the [automatic GitHub token](https://docs.github.com/en/actions/security-guides/automatic-token-authentication) provided to the workflow will be used. The token may be alternatively passed in an environment variable `GITHUB_TOKEN`. | |

2
action.yml
View file

@ -8,7 +8,7 @@ inputs:
description: 'The package 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 in the workspace are processed.' description: 'The package 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 in the workspace are processed.'
required: false required: false
manifest-path: manifest-path:
description: 'Path to Cargo.toml of crate or workspace to check.' description: 'Path to Cargo.toml of crate or workspace to check. By default, the action will assume it exists in the current directory.'
required: false required: false
verbose: verbose:
description: 'Enables verbose output of `cargo-semver-checks`.' description: 'Enables verbose output of `cargo-semver-checks`.'