mkdocs-gh-pages.yml

# Workflow for building and deploying a MkDocs site to GitHub Pages
name: Build Docs & Deploy to Pages

on:
  # Runs on pushes targeting the default branch
  push:
    branches:
      - "main"
    paths:
      - "mkdocs.yml"
      - "docs/**"

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  # Build viewer
  viewer:
    name: Build PDL live viewer
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: ./pdl-live
    steps:
      - uses: actions/checkout@v4

  # Build docs
  build:
    runs-on: ubuntu-latest
    needs: viewer
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      # Viewer
      - name: Set up node
        uses: actions/setup-node@v4
        with:
          node-version: 22
      - name: Install dependencies
        run: npm install
      - name: Generate pdl_ast.d.ts
        run: npx json2ts ../pdl-schema.json src/pdl_ast.d.ts --unreachableDefinitions
      - name: Build viewer
        run: npm run build
      - name: Copy viewer
        run: cp ./dist/bundle.js ../docs/dist/bundle.js
      # Docs
      - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.12'
      - name: Install required packages
        run: pip install -U mkdocs "mkdocstrings[python]" mkdocs-material pymdown-extensions
      - name: Build site (_site directory name is used for Jekyll compatiblity)
        run: mkdocs build --config-file ./mkdocs.yml --strict --site-dir ./_site
        env:
          CI: true
      # Deploy
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3

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