cargo-semver-checks/action.yml

39 lines
1.3 KiB
YAML
Raw Normal View History

name: 'cargo-semver-checks'
2022-07-21 01:34:12 +02:00
description: 'Ensure the public API in your Rust crate follows semantic versioning'
2022-08-10 07:28:06 +02:00
branding:
icon: 'check-circle'
2022-08-10 07:28:06 +02:00
color: 'green'
inputs:
crate-name:
2023-01-03 20:17:02 +01:00
description: 'The crate whose API to check for semver. If not set, all crates in the workspace are processed.'
required: false
default: ''
2023-01-03 20:39:25 +01:00
manifest-path:
description: 'Path to Cargo.toml of crate or workspace to check. Has an effect only if crate-name is not specified.'
required: false
default: ''
runs:
using: "composite"
steps:
- name: Install rust
uses: actions-rs/toolchain@v1
with:
toolchain: stable
profile: minimal
2023-01-03 20:17:02 +01:00
- name: Check for semver violations
2022-07-21 01:57:47 +02:00
shell: bash
2022-07-21 01:41:14 +02:00
run: |
2022-07-21 02:08:54 +02:00
set -euxo pipefail
2022-07-21 01:41:14 +02:00
# Colorize output, since GitHub Actions terminals support color.
export CARGO_TERM_COLOR=always
2023-01-03 20:39:25 +01:00
export CRATE_NAME="${{ inputs.crate-name }}"
export MANIFEST_PATH="${{ inputs.manifest-path }}"
export SEMVER_CHECKS_OPTIONS="${CRATE_NAME:+"--package $CRATE_NAME"} ${MANIFEST_PATH:+"--manifest-path $MANIFEST_PATH"}"
2022-07-21 01:41:14 +02:00
# Check for semver violations.
cargo install cargo-semver-checks --locked
2023-01-03 20:39:25 +01:00
cargo semver-checks check-release $SEMVER_CHECKS_OPTIONS