File tree Expand file tree Collapse file tree 1 file changed +24
-2
lines changed
Expand file tree Collapse file tree 1 file changed +24
-2
lines changed Original file line number Diff line number Diff line change @@ -142,9 +142,24 @@ jobs:
142142 - name : Check for unsupported C global variables
143143 if : github.event_name == 'pull_request' # $GITHUB_EVENT_NAME
144144 run : make check-c-globals
145- - name : Check for undocumented C APIs
146- run : make check-c-api-docs
147145
146+ check-c-api-docs :
147+ name : ' Check if all C APIs are documented'
148+ runs-on : ubuntu-latest
149+ timeout-minutes : 10
150+ needs : build-context
151+ if : >-
152+ needs.build-context.outputs.run-tests == 'true'
153+ || needs.build-context.outputs.run-docs == 'true'
154+ steps :
155+ - uses : actions/checkout@v4
156+ with :
157+ persist-credentials : false
158+ - uses : actions/setup-python@v5
159+ with :
160+ python-version : ' 3.x'
161+ - name : Check for undocumented C APIs
162+ run : python Tools/check-c-api-docs/main.py
148163
149164 build-windows :
150165 name : >-
@@ -685,6 +700,7 @@ jobs:
685700 - check-docs
686701 - check-autoconf-regen
687702 - check-generated-files
703+ - check-c-api-docs
688704 - build-windows
689705 - build-windows-msi
690706 - build-macos
@@ -721,6 +737,12 @@ jobs:
721737 '
722738 || ''
723739 }}
740+ ${{
741+ !fromJSON(needs.build-context.outputs.run-tests)
742+ && !fromJSON(needs.build-context.outputs.run-docs)
743+ && 'check-c-api-docs,'
744+ || ''
745+ }}
724746 ${{ !fromJSON(needs.build-context.outputs.run-windows-tests) && 'build-windows,' || '' }}
725747 ${{ !fromJSON(needs.build-context.outputs.run-ci-fuzz) && 'cifuzz,' || '' }}
726748 ${{ !fromJSON(needs.build-context.outputs.run-macos) && 'build-macos,' || '' }}
You can’t perform that action at this time.
0 commit comments