docs-validate-nav-build.yml

name: Docs - Validate nav.ts

on:
  pull_request:
  push:
    branches:
      - master
  merge_group:

jobs:
  validate-build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '16'

      - name: Install dependencies
        working-directory: docs
        run: |
          npm install

      - name: Backup existing nav.js
        working-directory: docs
        run: |
          mv docs/nav.js docs/nav.js.original

      - name: Build nav.ts
        working-directory: docs
        run: |
          npm run build

      - name: Compare generated nav.js with original nav.js
        working-directory: docs
        run: |
          diff -q docs/nav.js docs/nav.js.original || (echo "Generated nav.js differs from committed version. Run 'npm run build' and commit the updated file." && exit 1)

      # We do this after checking that nav.js matches nav.ts, to avoid confusing error messages if an author updates one but not the other.
      # If the .ts and .js are in sync, it doesn't matter which one we check against here.
      - name: Check that all files are listed in nav.js
        working-directory: docs
        run: |
          cp docs/nav.js docs/nav.mjs
          find docs -name '*.md' | sed 's!^docs/!!' > scripts/docs-files.txt
          node scripts/checkNav.mjs docs-files.txt

      - name: Restore original nav.js
        working-directory: docs
        if: success() || failure()
        run: |
          mv docs/nav.js.original docs/nav.js