docs.yml

# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Builds and publishes the MkDocs documentation site (`docs/public`) and the
# Astro preview site (`docs/site`, published under `/preview/`).
#
# On a pull request that touches docs sources, it runs a build-only check for
# both sites to catch errors without publishing. On a push to `main`, it builds
# both sites, stages the Astro output into `site/preview/`, and deploys to
# GitHub Pages via `ghp-import`. Before building, it copies the
# specification schemas into the docs tree (flattening versioned JSON to the
# version root for clean URLs) and converts GitHub-style admonitions to the
# MkDocs format. Runs only on the upstream `a2ui-project/a2ui` repository.
name: Docs

on:
  push:
    branches:
      - main
    paths:
      - ".github/workflows/docs.yml"
      - ".github/actions/setup-python/**"
      - "requirements-docs.txt"
      - "pyproject.toml"
      - "lychee.toml"
      - "mkdocs.yaml"
      - "hooks.py"
      - "specification/**"
      - "catalogs/**"
      - "docs/**"
  pull_request:
    branches:
      - main

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

jobs:
  changes:
    if: github.repository == 'a2ui-project/a2ui'
    runs-on: ubuntu-latest
    permissions:
      contents: read
    outputs:
      docs: ${{ steps.filter.outputs.docs }}
    steps:
      - name: Checkout Code
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false
      - name: Check for docs changes
        uses: dorny/paths-filter@0e4a8c6effa4802afeda77dc8d303f8176d7dfad # v3
        id: filter
        with:
          # An empty token makes the action diff `pull_request.base.sha..HEAD`
          # with git instead of reading the pull request's files from the
          # GitHub API, which fails the job when the API has a transient
          # error. It fetches the base commit itself, so the shallow checkout
          # above is enough. Push and scheduled runs always used git.
          token: ""
          filters: |
            docs:
              - ".github/workflows/docs.yml"
              - ".github/actions/setup-python/**"
              - "requirements-docs.txt"
              - "pyproject.toml"
              - "mkdocs.yaml"
              - "hooks.py"
              - "lychee.toml"
              - "specification/**"
              - "catalogs/**"
              - "docs/**"
              - "**.md"

  build_and_deploy:
    needs: changes
    if: github.repository == 'a2ui-project/a2ui' && (github.event_name == 'push' || needs.changes.outputs.docs == 'true')
    runs-on: ubuntu-latest
    # Requires write access to publish built documentation to gh-pages branch
    permissions:
      contents: write
      actions: read
    env:
      # Root package.json declares yarn as packageManager; allow standalone npm in docs/site.
      COREPACK_ENABLE_STRICT: "0"

    steps:
      - name: Checkout Code
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          fetch-depth: 0
          persist-credentials: ${{ github.event_name == 'push' }}

      - name: Configure Git Credentials
        if: github.event_name == 'push'
        run: |
          git config --global user.name github-actions[bot]
          git config --global user.email 41898282+github-actions[bot]@users.noreply.github.com

      - name: Setup Python
        uses: ./.github/actions/setup-python
        with:
          python-version: "3.13"

      - name: Install documentation dependencies
        run: |
          uv venv
          uv pip install -r requirements-docs.txt

      - name: Setup Node.js
        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
        with:
          node-version: "22"
          cache: "npm"
          cache-dependency-path: "docs/site/package-lock.json"

      - name: Install preview site dependencies
        run: npm --prefix docs/site ci || npm --prefix docs/site install --no-package-lock

      - name: Validate documentation conversion script
        run: uv run pytest docs/scripts/test_convert_docs.py

      - name: Copy schemas to documentation
        run: |
          mkdir -p docs/public/specification/
          cp -R specification/* docs/public/specification/
          # Catalogs live in the top-level catalogs/ directory but are published
          # under specification/<version>/catalogs/ so that catalog $id URLs
          # (e.g. https://a2ui.org/specification/v1_0/catalogs/basic/catalog.json)
          # keep resolving.
          mkdir -p docs/public/specification/v1_0/catalogs/basic
          cp catalogs/basic/v1/catalog.json docs/public/specification/v1_0/catalogs/basic/
          cp -R catalogs/basic/v1/examples docs/public/specification/v1_0/catalogs/basic/
          # The MCP catalog v1 targets protocol v1.0.
          mkdir -p docs/public/specification/v1_0/catalogs/mcp
          cp catalogs/mcp/v1/catalog.json docs/public/specification/v1_0/catalogs/mcp/
          cp -R catalogs/mcp/v1/examples docs/public/specification/v1_0/catalogs/mcp/
          # Flatten JSON files to version roots to support clean URLs without redirects
          for version in v0_8 v0_9 v0_9_1 v1_0; do
            if [ -d "docs/public/specification/$version/json" ]; then
              cp docs/public/specification/$version/json/*.json docs/public/specification/$version/
            fi
          done

      - name: Convert Admonitions in Documentation
        run: uv run python docs/scripts/convert_docs.py

      - name: Build Documentation (PR Check)
        if: github.event_name == 'pull_request'
        run: uv run mkdocs build

      - name: Build Preview Site (PR Check)
        if: github.event_name == 'pull_request'
        run: ASTRO_BASE=/preview/ npm --prefix docs/site run build

      # Pre-submit only: verify that links in every Markdown file resolve,
      # catching broken internal paths and dead external URLs. Placeholder URLs
      # and tuning live in lychee.toml at the repository root.
      - name: Restore lychee link-check cache
        if: github.event_name == 'pull_request'
        uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
        with:
          path: .lycheecache
          key: lychee-${{ github.sha }}
          restore-keys: lychee-

      - name: Verify Markdown links (PR Check)
        if: github.event_name == 'pull_request'
        uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0
        with:
          args: >-
            --config lychee.toml
            --cache
            --max-cache-age 1d
            --no-progress
            "**/*.md"
          fail: true
        env:
          # Authenticated GitHub API requests avoid rate limits on github.com links.
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Deploy development version from main branch
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
        run: |
          uv run mkdocs build
          ASTRO_BASE=/preview/ npm --prefix docs/site run build
          rm -rf site/preview && cp -R docs/site/dist site/preview
          # llms.txt is rendered by the Astro build; serve it from the site root.
          cp docs/site/dist/llms.txt site/llms.txt
          rm -f site/preview/CNAME site/preview/.nojekyll
          uv run ghp-import --no-jekyll --push \
            --message "Deployed $(git rev-parse --short HEAD) with MkDocs version: $(uv run python -c 'import mkdocs; print(mkdocs.__version__)')" \
            site