kernel-builder-cli-docs.yaml

name: Check CLI docs are up to date

on:
  pull_request:
    paths:
      - "kernel-builder/src/**"
      - "kernel-builder/Cargo.toml"
      - "docs/source/builder-cli.md"
      - "Makefile"
      - ".github/workflows/kernel-builder-cli-docs.yaml"
  push:
    branches:
      - main

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

permissions: {}

jobs:
  check-cli-docs:
    permissions:
      contents: read
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@29eef336d9b2848a0b548edc03f92a220660cdb8  # stable

      - name: Cache cargo registry and build
        uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9  # v6.1.0
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-cargo-cli-docs-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-cargo-cli-docs-

      - name: Generate CLI docs
        run: make kernel-builder-cli-docs

      - name: Check docs are up to date
        run: |
          if ! git diff --quiet docs/source/builder-cli.md; then
            echo "::error::builder-cli.md is out of date. Run 'make kernel-builder-cli-docs' to regenerate."
            git diff docs/source/builder-cli.md
            exit 1
          fi
          echo "CLI docs are up to date."