Skip to content

Commit 9f63262

Browse files
experiment with griffe as api stability check/followup
1 parent 18aa7f0 commit 9f63262

File tree

3 files changed

+233
-24
lines changed

3 files changed

+233
-24
lines changed

.github/workflows/api-check.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: API Stability Check
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- "*"
8+
9+
concurrency:
10+
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
11+
cancel-in-progress: true
12+
13+
env:
14+
FORCE_COLOR: 1
15+
16+
jobs:
17+
api-check:
18+
name: Check API stability with griffe
19+
runs-on: ubuntu-latest
20+
21+
steps:
22+
- uses: actions/checkout@v4
23+
with:
24+
fetch-depth: 0
25+
26+
- name: Setup Python
27+
uses: actions/setup-python@v5
28+
with:
29+
python-version: '3.11'
30+
31+
- name: Install dependencies
32+
run: |
33+
pip install -U pip setuptools
34+
pip install -e .[test]
35+
36+
- name: Run griffe API check
37+
run: |
38+
griffe check setuptools_scm -ssrc -f github

pyproject.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ test = [
6767
"rich",
6868
'typing-extensions; python_version < "3.11"',
6969
"wheel",
70+
"griffe",
71+
"flake8",
7072
]
7173
toml = [
7274
]

0 commit comments

Comments
 (0)