unshackle/.github/workflows/docs.yml

name: docs

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

concurrency:
  group: docs-deploy
  cancel-in-progress: false

permissions:
  contents: write

jobs:
  check:
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - uses: actions/setup-python@v6
        with:
          python-version: "3.x"
      - run: pip install -e . -r docs/requirements-docs.txt
      - run: mkdocs build --strict

  deploy:
    if: github.event_name != 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
        with:
          fetch-depth: 0
      - uses: actions/setup-python@v6
        with:
          python-version: "3.x"
      - run: pip install -e . -r docs/requirements-docs.txt
      - run: mkdocs gh-deploy --remote-branch docs