GitHub Action
Spec42 ships a composite GitHub Action for validating SysML v2 and KerML models in CI.
The Action downloads the matching release binary for the runner platform, optionally runs spec42 doctor, and then runs spec42 check.
Basic Usage
name: Spec42
on:
pull_request:
push:
branches: [main]
permissions:
contents: read
security-events: write
jobs:
validate-models:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: elan8/spec42@vX.Y.Z
with:
path: examples/timer/KitchenTimer.sysml
format: sarif
warnings-as-errors: true
When format is sarif, the Action writes spec42.sarif, uploads it to GitHub Code Scanning by default, and still fails the job if spec42 check reports validation errors.
Inputs
| Input | Default | Description |
|---|---|---|
version |
Action ref (github.action_ref, e.g. vX.Y.Z) |
Spec42 release tag to install. Omit to use the @vX.Y.Z ref from uses:. |
path |
required | File or workspace path to validate. |
workspace-root |
Optional workspace root passed to spec42 check. |
|
format |
sarif |
Output format: text, json, sarif, or junit. |
warnings-as-errors |
false |
Treat warnings as errors. |
baseline |
Optional baseline file passed to spec42 check. |
|
config |
Optional config file passed as --config. |
|
library-path |
Optional additional library root passed as --library-path. |
|
stdlib-path |
Optional standard library root passed as --stdlib-path. |
|
no-stdlib |
false |
Disable bundled standard library resolution. |
run-doctor |
true |
Run spec42 doctor before validation. |
upload-sarif |
true |
Upload SARIF to GitHub Code Scanning when format is sarif. |
sarif-file |
spec42.sarif |
SARIF output file path. |
Installing Only
The Action exposes the installed binary path as executable-path, so workflows can run additional CLI commands after validation.
- id: spec42
uses: elan8/spec42@vX.Y.Z
with:
path: examples/office
format: text
upload-sarif: false
- run: "${{ steps.spec42.outputs.executable-path }} generate --help"
Requirements and pitfalls
- Pin a version tag — Use
elan8/spec42@vX.Y.Z, not@main. The install step downloadsspec42-X.Y.Z-<platform>from GitHub Releases; branch refs have no matching archive. - Action ref vs CLI —
uses: elan8/spec42@vX.Y.Zselects the Action code at that tag; the CLI is downloaded for the same ref unless you overrideversion. Keep them aligned. - Checkout first — The Action does not check out your repository; add
actions/checkoutbefore Spec42. - Permissions — SARIF upload needs
security-events: write. On pull requests from forks, upload often fails even when validation passes; the Action uploads withcontinue-on-errorso the job still fails only onspec42 checkresults. warnings-as-errors— Whentrue, any warning fails the job. Large example repos may needfalseor a narrowerpathwhile tuning models.- Explicit version workaround — If an older Action tag cannot resolve its ref, set
version: vX.Y.Zinwith:.
Publishing Notes
The Action is available when this repository has a GitHub release/tag that contains the platform archives produced by .github/workflows/release.yml.
Use a version tag that includes this Action, such as the next Spec42 release tag, in downstream workflows so the Action code and downloaded CLI release stay aligned.
Spec42 validates action.yml in CI via .github/workflows/action-smoke.yml (actionlint + a real spec42 check against a published release).