Skip to content

Commit befbdaa

Browse files
make griffe only report as warning
1 parent 8d58d62 commit befbdaa

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

.github/workflows/api-check.yml

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,20 @@ jobs:
3434
pip install -e .[test]
3535
3636
- name: Run griffe API check
37+
id: griffe-check
3738
run: |
38-
griffe check setuptools_scm -ssrc -f github
39+
if griffe check setuptools_scm -ssrc -f github; then
40+
echo "api_check_result=success" >> $GITHUB_OUTPUT
41+
else
42+
echo "api_check_result=warning" >> $GITHUB_OUTPUT
43+
echo "API stability check detected changes but will not fail the build" >> $GITHUB_STEP_SUMMARY
44+
fi
45+
46+
- name: Report API check result
47+
if: steps.griffe-check.outputs.api_check_result == 'warning'
48+
uses: actions/github-script@v7
49+
with:
50+
script: |
51+
core.warning('API stability check detected breaking changes. Please review the API changes above.')
52+
core.summary.addRaw('⚠️ API Stability Warning: Breaking changes detected in the public API')
53+
await core.summary.write()

0 commit comments

Comments
 (0)