check-cmdline-ref.yml

name: Check Command Line Reference (comment /regenerate-cmdline-ref to auto-fix)

on:
  pull_request:
    branches: [master]
    types: [opened, synchronize, reopened, ready_for_review]

jobs:
  check-cmdline-ref:
    if: github.event.pull_request.draft != true
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: "recursive"

      - name: Install dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y libx11-dev

      - name: Setup
        uses: ./.github/actions/common-setup
        with:
          os: linux
          compiler: gcc
          platform: x86_64
          config: release
          build-llvm: false

      - name: Build Slang
        run: |
          cmake --preset default --fresh \
            -DSLANG_SLANG_LLVM_FLAVOR=DISABLE \
            -DSLANG_ENABLE_TESTS=OFF \
            -DSLANG_ENABLE_EXAMPLES=OFF \
            -DSLANG_ENABLE_GFX=OFF \
            -DSLANG_ENABLE_SLANGD=OFF \
            -DSLANG_EXCLUDE_DAWN=ON \
            -DSLANG_EXCLUDE_TINT=ON
          cmake --workflow --preset release

      - name: Generate command line reference
        run: |
          mkdir -p temp
          "$bin_dir/slangc" -help-style markdown -h > temp/command-line-slangc-reference.md

      - name: Compare with existing reference
        id: compare
        run: |
          if ! diff -q temp/command-line-slangc-reference.md docs/command-line-slangc-reference.md > /dev/null; then
            echo "Command line reference is out of date. Diff:"
            diff -u docs/command-line-slangc-reference.md temp/command-line-slangc-reference.md
            echo "Please run 'slangc -help-style markdown -h > docs/command-line-slangc-reference.md' or comment '/regenerate-cmdline-ref' on your PR."
            exit 1
          fi