docs.yaml

---
name: Docs
"on":
  push:
    # Only targets main branch to avoid amplification effects of auto-fixing
    # the exact same stuff in multiple non-rebased branches.
    branches:
      - main

# XXX Concurrency detection sucks and jobs gets killed randonmly.
# concurrency:
#   # Group workflow jobs so new commits cancels in-progress execution triggered by previous commits.
#   # Source: https://mail.python.org/archives/list/pypa-committers@python.org/thread/PCBCQMJF64JGRBOX7E2EE4YLKHT4DI55/
#   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
#   cancel-in-progress: true

jobs:

  docs:
    uses: kdeldycke/workflows/.github/workflows/docs.yaml@v2.15.1

  update-docs:
    needs: docs
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v3.5.2
      - uses: actions/setup-python@v4.6.1
        with:
          python-version: "3.11"
      - name: Install click-extra
        run: |
          python -m pip install --upgrade pip
          python -m pip install --upgrade poetry
          poetry install --only main --no-interaction
      - name: Generate dynamic doc
        run: |
          poetry run python -m click_extra.docs_update
      - uses: peter-evans/create-pull-request@v5.0.1
        with:
          assignees: ${{ github.actor }}
          commit-message: "[autofix] Regenerate documentation."
          title: "[autofix] Regenerate documentation"
          body: >
            <details><summary><code>Workflow metadata</code></summary>


            > [Auto-generated on run `#${{ github.run_id }}`](${{ github.event.repository.html_url }}/actions/runs/${{
            github.run_id }}) by `${{ github.job }}` job from [`docs.yaml`](${{ github.event.repository.html_url
            }}/blob/${{ github.sha }}/.github/workflows/docs.yaml) workflow.


            </details>
          labels: "📚 documentation"
          branch: update-docs