docs.yml

name: Deploy Docs

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
  release:
    types: [published]
  workflow_dispatch:

permissions:
  contents: write

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

jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
        with:
          fetch-depth: 0
          persist-credentials: false

      - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6
        with:
          python-version: '3.12'

      - name: Install dependencies
        run: pip install 'mkdocs>=1.6,<2' 'mkdocs-material>=9.7,<10' pyyaml mike

      - name: Validate docsite config
        run: cd scripts && python -m docsite --validate

      - name: Build docs
        run: cd scripts && python -m docsite --output-dir /tmp/argus-docs

      - name: Verify site builds
        run: cd /tmp/argus-docs && mkdocs build --strict --site-dir /tmp/site

      - name: Configure git for mike
        if: github.event_name == 'release'
        run: |
          git config user.name "github-actions[bot]"
          git config user.email "github-actions[bot]@users.noreply.github.com"
          git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Deploy versioned docs
        if: github.event_name == 'release'
        run: |
          VERSION=$(head -1 version.yaml | awk '{print $1}')
          mike deploy --push --update-aliases "$VERSION" latest \
            --config-file /tmp/argus-docs/mkdocs.yml
          mike set-default --push latest \
            --config-file /tmp/argus-docs/mkdocs.yml
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}