build-docs.yml

name: Build docs site

on:
  push:
    branches:
      - master
  pull_request:

permissions:
  deployments: write
  issues: write
  pull-requests: write
  statuses: write

jobs:
  build:
    runs-on: ubuntu-latest
    timeout-minutes: 60

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

    steps:
      # - name: Set Swap Space
      #   uses: pierotofy/set-swap-space@master
      #   with:
      #     swap-size-gb: 6

      - name: Checkout
        uses: actions/checkout@v4
        with:
          # Fetches all commit history for a single branch. We need commit
          # history for accurate "last updated" dates on each page, but fetch
          # depth of 0 would fetch all branches which is slow.
          # https://github.com/actions/checkout/issues/520#issuecomment-1320838255
          fetch-depth: 2147483647

      - name: Use Node.js 20
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: 'npm'

      - name: Cache Webpack Build
        uses: actions/cache@v4
        env:
          TAR_OPTIONS: "--remove-files"
        with:
          path: node_modules/.cache/rspack
          key: cache-webpack-${{ github.base_ref || github.ref_name }}

      - name: Install Dependencies
        run: npm ci --omit=dev

      - name: Build with Docusaurus
        run: npm run build

      - name: Deploy to Netlify
        id: deploy
        if: ${{ github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository }}
        uses: nwtgck/actions-netlify@v3
        with:
          publish-dir: build
          production-branch: master
          github-token: ${{ secrets.GITHUB_TOKEN }}
          deploy-message: "Deploy from GitHub Actions"
          enable-pull-request-comment: true
          enable-commit-comment: false
          overwrites-pull-request-comment: true
        env:
          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}

      - name: Compress Build Archive
        if: ${{ steps.deploy.conclusion == 'skipped' }}
        run: tar --label=${{ github.event.pull_request.number }} --remove-files --zstd -cf build.tar.zst build

      - name: Upload Build Artifact
        if: ${{ steps.deploy.conclusion == 'skipped' }}
        uses: actions/upload-artifact@v4
        with:
          name: preview-build
          path: build.tar.zst
          retention-days: 1