Any CI runner
How to run kiira check in any CI system — install the CLI, run with the github or json reporter, and rely on exit codes. Includes a plain GitHub Actions example without the composite action.
The recipe
You don't need the composite action to run Kiira in CI. The pattern is the same everywhere:
- Install the CLI (it's just a dev dependency).
- Run
kiira checkwith a CI-friendly reporter. - Rely on exit codes — Kiira exits
1on validation errors and2on a setup failure, and CI fails the step on any non-zero exit.
pnpm install --frozen-lockfilepnpm kiira check --reporter githubUse --reporter github on GitHub Actions for inline annotations, or --reporter json anywhere you want to capture machine-readable output:
pnpm kiira check --reporter json > kiira-report.jsonPlain GitHub Actions (no composite action)
If you'd rather call the CLI directly instead of using the Kiira action:
name: Docson: [push, pull_request]jobs: kiira: runs-on: ubuntu-latest steps:- uses: actions/checkoutv4- uses: pnpm/action-setupv4- uses: actions/setup-nodev4 with: node-version: 22 cache: pnpm- run: pnpm install --frozen-lockfile- run: pnpm kiira check --reporter githubThe github reporter emits workflow commands, so failures still appear as inline annotations even without the composite action.
Works in any runner
Because Kiira is a normal CLI that communicates through stdout and exit codes, it runs unchanged in GitLab CI, CircleCI, Jenkins, Buildkite, or any other runner. Install it, run kiira check, and let the non-zero exit code fail the job:
# Generic CI steppnpm install --frozen-lockfilepnpm kiira check --reporter json --raw --staticSee Exit codes for how to distinguish a docs failure (1) from a setup failure (2).