Fix issue link #1554
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| --- | |
| 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/[email protected]/thread/PCBCQMJF64JGRBOX7E2EE4YLKHT4DI55/ | |
| # group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }} | |
| # cancel-in-progress: true | |
| jobs: | |
| docs: | |
| uses: kdeldycke/workflows/.github/workflows/[email protected] | |
| update-docs: | |
| needs: docs | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/[email protected] | |
| - uses: actions/[email protected] | |
| with: | |
| python-version: "3.12" | |
| - 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/[email protected] | |
| 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 |