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-22 07:59:32 +01:00
Code Issues Projects Activity Pipelines

README improvements

Browse source
This commit is contained in:
Mieszko Grodzicki 2023-01-01 17:03:18 +01:00 committed by Predrag Gruevski
parent edc4f7e32f
commit cee821a331
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -19,15 +19,15 @@ Every argument is optional.
| Input | Description | Default |
|--------------------|-----------------------------------------------------------------------------------------------------------------------------------|---------|
| crate-name | The crate whose API to check for semver | |
| crate-target | By default, check the library target of the crate. To check a different target (e.g. a binary target), set this to `--bin <NAME>` | `--lib` |
| version-tag-prefix | The prefix to use for the git tag for a version; the default "v" creates tags like "v1.0.0" | `v` |
| crate-name | The crate whose API to check for semver (needed only in multi-crate workspaces). | |
| crate-target | (Deprecated) By default, check the library target of the crate. To check a different target (e.g. a binary target), set this to `--bin <NAME>`. Will be removed in future versions, as bin targets do not have library-like API to check. | `--lib` |
| version-tag-prefix | The prefix to use for the git tag for a version; the default "v" creates tags like "v1.0.0". | `v` |
# Scenarios
- [Use with a different version tag format](#use-with-a-different-version-tag-format)
- [Use in workspaces with more than one crate](#use-in-workspaces-with-more-than-one-crate)
- [Use with binary crates or crates with more than one target](#use-with-binary-crates-or-crates-with-more-than-one-target)
- [(Deprecated) Use with binary crates or crates with more than one target](#deprecated-use-with-binary-crates-or-crates-with-more-than-one-target)
## Use with a different version tag format
@ -60,7 +60,7 @@ For example, this will check `my-crate` whose releases are tagged as `my-crate-v
run: # your `cargo publish` code here
```
## Use with binary crates or crates with more than one target
## (Deprecated) Use with binary crates or crates with more than one target
To check a different (non-library) target in a crate, use the `crate-target` setting:
```yaml