docs-pr.yml

name: Documentation PR Check

on:
  pull_request:
    paths:
      - 'docs/**'
      - 'mkdocs.yml'
      - 'python/**'
      - 'scripts/embed_wpt_conformance_pages.sh'
      - '.github/workflows/docs*.yml'

permissions:
  pull-requests: write
  contents: read

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'
          cache: 'pip'

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r docs/requirements.txt

      - name: Check documentation build
        run: mkdocs build --strict --verbose

      - name: Restore published WPT conformance report
        uses: actions/cache/restore@v4
        with:
          path: reports
          key: wpt-conformance-pages-${{ runner.os }}-latest

      - name: Embed WPT conformance report
        run: bash scripts/embed_wpt_conformance_pages.sh site

      - name: Check for broken links
        run: |
          echo "Checking for broken internal links..."
          ! grep -r "404.html" site/ && echo "[OK] No broken links found" || (echo "[FAIL] Broken links detected" && exit 1)

      - name: Comment on PR
        if: always() && github.event.pull_request.head.repo.full_name == github.repository
        uses: actions/github-script@v7
        with:
          script: |
            const fs = require('fs');
            const output = `### Documentation Build ${process.env.BUILD_STATUS === 'success' ? '✅' : '❌'}

            ${process.env.BUILD_STATUS === 'success'
              ? 'Documentation builds successfully! 🎉'
              : 'Documentation build failed. Please check the logs above.'}

            Preview will be available after merge.`;

            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: output
            });
        env:
          BUILD_STATUS: ${{ job.status }}