docs.yml

# Documentation site: builds the MkDocs site with --strict (0 warnings required) on every pull request and publishes it to
# GitHub Pages when main changes. One-time setup in the repository: Settings -> Pages -> Source: "GitHub Actions".
# The site is https://josephcodemard.github.io/UltrafastEngine/ (site_url in mkdocs.yml).
name: Docs

on:
  push:
    branches: [main]
    paths: ["docs/**", "overrides/**", "mkdocs.yml", ".github/workflows/docs.yml"]
  pull_request:
    paths: ["docs/**", "overrides/**", "mkdocs.yml", ".github/workflows/docs.yml"]
  workflow_dispatch:

permissions:
  contents: read

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

jobs:
  build:
    name: Build the site (strict)
    runs-on: ubuntu-24.04
    timeout-minutes: 30
    steps:
      - uses: actions/checkout@v7
      - uses: actions/setup-python@v7
        with:
          python-version: "3.12"
      - name: Install MkDocs
        run: pip install mkdocs
      - name: Build (any warning fails the job)
        run: mkdocs build --strict
      - uses: actions/configure-pages@v5
        if: github.event_name != 'pull_request'
      - uses: actions/upload-pages-artifact@v3
        if: github.event_name != 'pull_request'
        with:
          path: site

  deploy:
    name: Publish to GitHub Pages
    if: github.event_name != 'pull_request'
    needs: build
    runs-on: ubuntu-24.04
    timeout-minutes: 30
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@v4