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 16:09:33 +01:00
Code Issues Projects Activity Pipelines

Update scenario description in README

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

7
README.md
View file

@ -22,17 +22,14 @@ Every argument is optional.
## Use in workspaces with more than one crate ## Use in workspaces with more than one crate
By default, if workspace contains multiple crates, all of them are checked against semver violations. You can specify single crate to be checked instead, along with the format used for version tags for that crate: By default, if workspace contains multiple crates, all of them are checked against semver violations. You can specify single crate to be checked instead using `crate-name`.
- `crate-name` specifies the crate to check, and
- `version-tag-prefix` sets the text prepended to the version number to create the git tag for that release.
For example, this will check `my-crate` whose releases are tagged as `my-crate-v1.2.3`: For example, this will check `my-crate`:
```yaml ```yaml
- name: Check semver - name: Check semver
uses: obi1kenobi/cargo-semver-checks-action@v1 uses: obi1kenobi/cargo-semver-checks-action@v1
with: with:
crate-name: my-crate crate-name: my-crate
version-tag-prefix: my-crate-v
- name: Publish my-crate to crates.io - name: Publish my-crate to crates.io
run: # your `cargo publish` code here run: # your `cargo publish` code here
``` ```