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-29 11:29:32 +01:00
Code Issues Projects Activity Pipelines

New structure of README

Browse source
This commit is contained in:
Mieszko Grodzicki 2022-12-31 14:44:23 +01:00 committed by Predrag Gruevski
parent e410d1ab7a
commit edc4f7e32f
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -13,6 +13,22 @@ Single-crate workspaces can use it as:
run: # your `cargo publish` code here run: # your `cargo publish` code here
``` ```
# Input options
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` |
# 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)
## Use with a different version tag format ## Use with a different version tag format
Change the `version-tag-prefix` setting to reflect the prefix used to create the version tag. The setting's default value `'v'` creates version tags like `v1.2.3`. Change the `version-tag-prefix` setting to reflect the prefix used to create the version tag. The setting's default value `'v'` creates version tags like `v1.2.3`.