python/cpython
Publicmirrored from https://github.com/python/cpythonAvailable
.github/workflows/reusable-check-c-api-docs.yml
25lines · modecode
| 1 | name: Reusable C API Docs Check |
| 2 | |
| 3 | on: |
| 4 | workflow_call: |
| 5 | |
| 6 | permissions: |
| 7 | contents: read |
| 8 | |
| 9 | env: |
| 10 | FORCE_COLOR: 1 |
| 11 | |
| 12 | jobs: |
| 13 | check-c-api-docs: |
| 14 | name: 'Check if all C APIs are documented' |
| 15 | runs-on: ubuntu-latest |
| 16 | timeout-minutes: 5 |
| 17 | steps: |
| 18 | - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 |
| 19 | with: |
| 20 | persist-credentials: false |
| 21 | - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 |
| 22 | with: |
| 23 | python-version: '3.x' |
| 24 | - name: Check for undocumented C APIs |
| 25 | run: python Tools/check-c-api-docs/main.py |