docs.yml

name: Documentation

# Build and deploy documentation to GitHub Pages
# - On push to main with docs changes: Build and deploy
# - Standalone workflow for documentation deployment only

on:
  push:
    branches: [main]
    paths:
      - "docs/**"
      - ".github/workflows/docs.yml"
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment
concurrency:
  group: pages-${{ github.ref }}
  cancel-in-progress: true

jobs:
  # Build documentation using vx
  build:
    name: Build Documentation (via vx)
    runs-on: ubuntu-latest
    timeout-minutes: 15
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Setup vx
        uses: ./
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          cache: "false"

      - name: Cache vx tools
        uses: actions/cache@v5
        with:
          path: ~/.vx
          key: ${{ runner.os }}-vx-docs-${{ hashFiles('docs/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-vx-docs-

      # vx automatically installs Node.js when running npm commands
      # No need for explicit "vx install node" step

      - name: Install dependencies
        run: |
          # Ensure system paths are available for npm postinstall scripts
          export PATH="/usr/local/bin:/usr/bin:/bin:$PATH"
          vx just docs-install

      - name: Build documentation
        run: vx just docs-build

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: docs/.vitepress/dist

  # Deploy to GitHub Pages
  deploy:
    name: Deploy to GitHub Pages
    needs: build
    runs-on: ubuntu-latest
    timeout-minutes: 10
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5

      - name: Summary
        run: |
          echo "## Documentation Deployed" >> $GITHUB_STEP_SUMMARY
          echo "" >> $GITHUB_STEP_SUMMARY
          echo "Documentation has been deployed to GitHub Pages!" >> $GITHUB_STEP_SUMMARY
          echo "" >> $GITHUB_STEP_SUMMARY
          echo "URL: ${{ steps.deployment.outputs.page_url }}" >> $GITHUB_STEP_SUMMARY