GitHub Action
Run SpecSync in CI with zero setup. Auto-detects OS/arch, downloads the binary, runs validation.
Table of contents
- Basic Usage
- Inputs
- Full Workflow
- Multi-Platform Matrix
- Monorepo
- Manual CI (without the action)
- Available Binaries
Basic Usage
- uses: CorvidLabs/spec-sync@v1
with:
strict: 'true'
require-coverage: '100'
| Input | Default | Description |
version | latest | Release version to download |
strict | false | Treat warnings as errors |
require-coverage | 0 | Minimum file coverage % (0–100) |
root | . | Project root directory |
args | '' | Extra CLI arguments passed to specsync check |
Full Workflow
name: Spec Check
on: [push, pull_request]
jobs:
specsync:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: CorvidLabs/spec-sync@v1
with:
strict: 'true'
require-coverage: '100'
jobs:
specsync:
strategy:
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
runs-on: $
steps:
- uses: actions/checkout@v4
- uses: CorvidLabs/spec-sync@v1
with:
strict: 'true'
Monorepo
- uses: CorvidLabs/spec-sync@v1
with:
root: './packages/backend'
strict: 'true'
Manual CI (without the action)
- name: Install specsync
run: |
curl -sL https://github.com/CorvidLabs/spec-sync/releases/latest/download/specsync-linux-x86_64.tar.gz | tar xz
sudo mv specsync-linux-x86_64 /usr/local/bin/specsync
- name: Spec check
run: specsync check --strict --require-coverage 100
Available Binaries
| Platform | Binary |
| Linux x86_64 | specsync-linux-x86_64 |
| Linux aarch64 | specsync-linux-aarch64 |
| macOS x86_64 | specsync-macos-x86_64 |
| macOS aarch64 (Apple Silicon) | specsync-macos-aarch64 |
| Windows x86_64 | specsync-windows-x86_64.exe |