A GitHub Action for running cargo-semver-checks
Find a file
2023-02-27 16:42:26 -05:00
.github Add dist/ check to CI (#8) 2023-02-27 16:42:26 -05:00
dist [TEMP-FIX] Add creating index directory on Windows (#9) 2023-02-27 16:42:26 -05:00
src [TEMP-FIX] Add creating index directory on Windows (#9) 2023-02-27 16:42:26 -05:00
.gitignore brand-new action in node.js (#4) 2023-02-27 16:42:26 -05:00
.npmrc brand-new action in node.js (#4) 2023-02-27 16:42:26 -05:00
action.yml Add ending newlines 2023-02-27 16:42:26 -05:00
LICENSE Initial commit 2022-07-20 18:45:54 -04:00
package-lock.json [TEMP-FIX] Add creating index directory on Windows (#9) 2023-02-27 16:42:26 -05:00
package.json [TEMP-FIX] Add creating index directory on Windows (#9) 2023-02-27 16:42:26 -05:00
README.md Typos in README.md 2023-02-27 16:42:26 -05:00
tsconfig.json Add ending newlines 2023-02-27 16:42:26 -05:00

cargo-semver-checks-action

Lint your crate API changes for semver violations.

- name: Check semver
  uses: obi1kenobi/cargo-semver-checks-action@v2
- name: Publish to crates.io
  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. If not set, all crates in the workspace are processed.
manifest-path Path to Cargo.toml of crate or workspace to check. Has an effect only if crate-name is not specified.
verbose Enables verbose output of cargo-semver-checks. false

Scenarios

Use in workspaces with more than one crate

By default, if workspace contains multiple crates, all of them are checked for semver violations. You can specify a single crate to be checked instead using crate-name or manifest-path.

For example, this will check my-crate:

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