https://github.com/python/cpython/commit/a722c8d45aa64a6940bfbd7297534dbcd0e89c2b
commit: a722c8d45aa64a6940bfbd7297534dbcd0e89c2b
branch: 3.14
author: Stan Ulbrych <[email protected]>
committer: StanFromIreland <[email protected]>
date: 2026-07-24T19:42:47+02:00
summary:
[3.14] gh-141004: GHA: Run `check-c-api-docs` check on docs-only PRs
(GH-143573) (#154464)
(cherry picked from commit e5b5a1580411fb9587af8974db68f0857033ba14)
files:
A .github/workflows/reusable-check-c-api-docs.yml
M .github/workflows/build.yml
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index b9174b0c300b941..287dccdbaad26ec 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -187,9 +187,14 @@ jobs:
- name: Check for unsupported C global variables
if: github.event_name == 'pull_request' # $GITHUB_EVENT_NAME
run: make check-c-globals
- - name: Check for undocumented C APIs
- run: make check-c-api-docs
+ check-c-api-docs:
+ name: C API Docs
+ needs: build-context
+ if: >-
+ needs.build-context.outputs.run-tests == 'true'
+ || needs.build-context.outputs.run-docs == 'true'
+ uses: ./.github/workflows/reusable-check-c-api-docs.yml
build-windows:
name: >-
@@ -674,6 +679,7 @@ jobs:
- check-docs
- check-autoconf-regen
- check-generated-files
+ - check-c-api-docs
- build-windows
- build-windows-msi
- build-macos
@@ -710,6 +716,12 @@ jobs:
'
|| ''
}}
+ ${{
+ !fromJSON(needs.build-context.outputs.run-tests)
+ && !fromJSON(needs.build-context.outputs.run-docs)
+ && 'check-c-api-docs,'
+ || ''
+ }}
${{ !fromJSON(needs.build-context.outputs.run-windows-tests) &&
'build-windows,' || '' }}
${{
!fromJSON(needs.build-context.outputs.run-ci-fuzz)
diff --git a/.github/workflows/reusable-check-c-api-docs.yml
b/.github/workflows/reusable-check-c-api-docs.yml
new file mode 100644
index 000000000000000..db030c80008b1ed
--- /dev/null
+++ b/.github/workflows/reusable-check-c-api-docs.yml
@@ -0,0 +1,25 @@
+name: Reusable C API Docs Check
+
+on:
+ workflow_call:
+
+permissions:
+ contents: read
+
+env:
+ FORCE_COLOR: 1
+
+jobs:
+ check-c-api-docs:
+ name: 'Check if all C APIs are documented'
+ runs-on: ubuntu-latest
+ timeout-minutes: 5
+ steps:
+ - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 #
v7.0.0
+ with:
+ persist-credentials: false
+ - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 #
v6.2.0
+ with:
+ python-version: '3.x'
+ - name: Check for undocumented C APIs
+ run: python Tools/check-c-api-docs/main.py
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
