docs.yml

name: Deploy Documentation

on:
  push:
    branches: [main]
    paths:
    - 'docs/**'
  workflow_dispatch:

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

# Only one Pages deployment at a time; don't cancel in-progress deploys.
concurrency:
  group: 'pages'
  cancel-in-progress: false

jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v7
      with:
        submodules: true # pulls in docs/themes/hugo-book
        fetch-depth: 0 # required for enableGitInfo = true

    - name: Setup Hugo
      uses: peaceiris/actions-hugo@v3.2.1
      with:
        hugo-version: '0.164.0'
        extended: true # required for SCSS compilation in hugo-book theme

    - name: Configure Pages
      id: pages
      uses: actions/configure-pages@v6

    - name: Build
      env:
        BASE_URL: ${{ steps.pages.outputs.base_url }}
      run: hugo --environment public --minify --baseURL "$BASE_URL/"
      working-directory: docs

    - name: Upload artifact
      uses: actions/upload-pages-artifact@v5
      with:
        path: docs/public

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