docs.yml

name: Docs

on:
  push:
    branches: [main]
  pull_request:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: '3.x'

      - name: Install mkdocs
        run: pip install mkdocs

      - name: Build docs
        run: mkdocs build --strict

  deploy:
    if: github.ref == 'refs/heads/main'
    needs: build

    permissions:
      contents: write

    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: '3.x'

      - name: Install mkdocs
        run: pip install mkdocs

      - name: Setup Git
        run: |
          git config --global user.name 'poac-bot'
          git config --global user.email '134275478+poac-bot@users.noreply.github.com'

      - name: Publish docs
        run: mkdocs gh-deploy --no-history