actions/cargo-semver-checks
actions/cargo-semver-checks
3
0
Fork 0
mirror of https://github.com/obi1kenobi/cargo-semver-checks-action.git synced 2025-01-31 07:01:19 +01:00
Code Issues Projects Activity Pipelines

Mark the README code blocks as YAML.

Browse source
This commit is contained in:
Predrag Gruevski 2022-08-07 22:10:06 -04:00 • committed by GitHub
parent 31abdeda61
commit 40ca351feb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -6,7 +6,7 @@ By default, this action assumes that:
- Your releases are tagged in git as `v{major}.{minor}.{patch}`, for example `v1.2.3`. - Your releases are tagged in git as `v{major}.{minor}.{patch}`, for example `v1.2.3`.
Single-crate workspaces can use it as: Single-crate workspaces can use it as:
``` ```yaml
- name: Check semver - name: Check semver
uses: obi1kenobi/cargo-semver-checks-action@v1 uses: obi1kenobi/cargo-semver-checks-action@v1
- name: Publish to crates.io - name: Publish to crates.io
@ -18,7 +18,7 @@ In a workspace with more than one crate:
- use the `version-tag-prefix` setting to override the default prefix `v` to match the way the releases of your crate are tagged. The version number `1.2.3` will be appended to this prefix. - use the `version-tag-prefix` setting to override the default prefix `v` to match the way the releases of your crate are tagged. The version number `1.2.3` will be appended to this prefix.
For example, this is publishing `my-crate` whose releases are tagged as `my-crate-v1.2.3`: For example, this is publishing `my-crate` whose releases are tagged as `my-crate-v1.2.3`:
``` ```yaml
- name: Check semver - name: Check semver
uses: obi1kenobi/cargo-semver-checks-action@v1 uses: obi1kenobi/cargo-semver-checks-action@v1
with: with:
@ -29,7 +29,7 @@ For example, this is publishing `my-crate` whose releases are tagged as `my-crat
``` ```
To check a different (non-library) target in a crate, use the `crate-target` setting: To check a different (non-library) target in a crate, use the `crate-target` setting:
``` ```yaml
- name: Check semver for my_binary - name: Check semver for my_binary
uses: obi1kenobi/cargo-semver-checks-action@v1 uses: obi1kenobi/cargo-semver-checks-action@v1
with: with: