GitHub Action

Usage

Add the Kiira action to a workflow. With the github reporter (the action's default), failures appear as inline annotations on the exact Markdown line in the pull request:

-uses: AlemTuzlak/kiirav1
  with:
    command: pnpm kiira check
    reporter: github

A complete workflow:

name: Docs
on: [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
-      uses: AlemTuzlak/kiirav1
        with:
          command: pnpm kiira check
          reporter: github

Inputs

| Input | Default | Description | | --- | --- | --- | | command | kiira check | The Kiira command to run. | | config | — | Path to a Kiira config file. | | reporter | github | Output format: pretty, github, json, or sarif. | | files | — | Space-separated globs to check. | | working-directory | . | Directory to run Kiira in. |

command

The command the action runs. Defaults to kiira check. Use pnpm kiira check (or your package manager's equivalent) when Kiira is a dev dependency:

with:
  command: pnpm kiira check

config

Path to a specific config file, equivalent to the CLI --config flag:

with:
  config: configs/kiira.config.ts

reporter

Output format. Defaults to github so failures become inline PR annotations. Also accepts pretty, json, and sarif:

with:
  reporter: github

files

Space-separated globs to check, equivalent to passing --entry on the CLI:

with:
  files: "docs/**/*.mdx README.md"

working-directory

The directory to run Kiira in. Defaults to .. Point it at a docs subfolder in a monorepo:

with:
  working-directory: docs