cargo-semver-checks/README.md

cargo-semver-checks-action

A GitHub Action for running cargo-semver-checks

By default, this action assumes that:

• Your cargo workspace contains a single crate which contains a library target.
• Your releases are tagged in git as v{major}.{minor}.{patch}, for example v1.2.3.

Single-crate workspaces can use it as:

- name: Check semver
  uses: obi1kenobi/cargo-semver-checks-action@v1
- name: Publish to crates.io
  run: # your `cargo publish` code here

In a workspace with more than one crate:

• use the crate-name setting to specify which crate should be checked in a given run, and
• 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:

- name: Check semver
  uses: obi1kenobi/cargo-semver-checks-action@v1
  with:
    crate-name: my-crate
    version-tag-prefix: my-crate-v
- name: Publish my-crate to crates.io
  run: # your `cargo publish` code here

To check a different (non-library) target in a crate, use the crate-target setting:

- name: Check semver for my_binary
  uses: obi1kenobi/cargo-semver-checks-action@v1
  with:
    crate-target: --bin my_binary
- name: Publish my-crate to crates.io
  run: # your `cargo publish` code here