docs.yml (720B)
1 name: docs 2 on: 3 pull_request: 4 types: [opened, synchronize, reopened, ready_for_review] 5 jobs: 6 docs: 7 runs-on: ubuntu-latest 8 if: github.event.pull_request.draft == false 9 permissions: 10 contents: write 11 pull-requests: write 12 steps: 13 - uses: actions/checkout@v6 14 - uses: ./.github/actions/setup 15 16 - name: Generate docs 17 run: | 18 make doc 19 if [ -n "$(git status --porcelain)" ]; then 20 echo "::error::Job failed, run 'make doc' and commit your doc changes." 21 echo "::error::The doc generation produces the following changes:" 22 git diff --color --exit-code 23 fi 24 25 - name: Validate docs 26 run: make lintdoc