docs.yml

name: Deploy documentation to GitHub Pages

on:
  push:
    branches: [main]

  workflow_dispatch:

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

concurrency:
  group: pages
  cancel-in-progress: true

env:
  NODE_OPTIONS: --max-old-space-size=16384
  DOCUSAURUS_SSR_CONCURRENCY: 10

jobs:
  deploy:
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup pnpm
        uses: pnpm/action-setup@v4
        with:
          version: 9.4.0
          run_install: false
      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: pnpm
      - name: Setup .NET
        uses: actions/setup-dotnet@v4
        with:
          dotnet-version: | # 6.0 required by dfmg
            8.0.x
            6.0.x
      - name: Install .NET tools
        run: |
          dotnet tool install -g docfx
          dotnet tool install -g DocFxMarkdownGen
      - name: Install dependencies
        run: pnpm install --frozen-lockfile
      - name: Setup Docusaurus cache
        uses: docuactions/cache@v1.1
      - name: Build
        run: pnpm run ci
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: build/
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4