docs.yml

name: Docs

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

permissions:
  contents: read

env:
  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: "true"

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v6.0.2
    - name: Set up Python 3.13
      uses: actions/setup-python@v6.2.0
      with:
        python-version: "3.13"
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install ".[test,docs]"
    - name: Check generated aiograpi coverage docs
      run: |
        python scripts/generate_aiograpi_coverage.py --check
    - name: Build docs
      run: |
        mkdocs build --strict

  publish:
    if: github.event_name == 'push' && github.repository == 'subzeroid/aiograpi-rest'
    needs: build
    runs-on: ubuntu-latest
    permissions:
      contents: write

    steps:
    - uses: actions/checkout@v6.0.2
      with:
        fetch-depth: 0
    - name: Set up Python 3.13
      uses: actions/setup-python@v6.2.0
      with:
        python-version: "3.13"
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install ".[test,docs]"
    - name: Generate aiograpi coverage docs
      run: |
        python scripts/generate_aiograpi_coverage.py
    - name: Publish GitHub Pages
      run: |
        mkdocs gh-deploy --force