fix 1180 provide dummy scmversion for dump #74
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: API Stability Check | |
on: | |
pull_request: | |
push: | |
branches: | |
- "*" | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }} | |
cancel-in-progress: true | |
env: | |
FORCE_COLOR: 1 | |
jobs: | |
api-check: | |
name: Check API stability with griffe | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Setup Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.11' | |
- name: Install dependencies | |
run: | | |
pip install -U pip setuptools | |
pip install -e .[test] | |
- name: Run griffe API check | |
id: griffe-check | |
run: | | |
if griffe check setuptools_scm -ssrc -f github; then | |
echo "api_check_result=success" >> $GITHUB_OUTPUT | |
else | |
echo "api_check_result=warning" >> $GITHUB_OUTPUT | |
echo "API stability check detected changes but will not fail the build" >> $GITHUB_STEP_SUMMARY | |
fi | |
- name: Report API check result | |
if: steps.griffe-check.outputs.api_check_result == 'warning' | |
uses: actions/github-script@v7 | |
with: | |
script: | | |
core.warning('API stability check detected breaking changes. Please review the API changes above.') | |
core.summary.addRaw('⚠️ API Stability Warning: Breaking changes detected in the public API') | |
await core.summary.write() |