github-pages.yaml

name: 'Build documentation and deploy to GitHub Pages'

on:
  push:
    branches:
      - 'master'
  workflow_dispatch:

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

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

jobs:
  build:
    runs-on: 'ubuntu-latest'
    steps:

      - name: 'Checkout'
        uses: 'actions/checkout@v4'

      - name: 'Configure Pages'
        uses: 'actions/configure-pages@v5'

      - name: 'Build documentation'
        run: docker compose run --no-TTY --user="$(id -u):$(id -g)" docs-build

      - name: 'Upload artifact'
        uses: 'actions/upload-pages-artifact@v3'
        with:
          path: 'html/'

  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'