Merge pull request #1156 from RonnyPfannschmidt/api-stability

experiment with griffe as api stability check/followup

Author: RonnyPfannschmidt

.github/workflows/api-check.yml

@@ -0,0 +1,38 @@
+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
+        run: |
+          griffe check setuptools_scm -ssrc -f github

pyproject.toml

@@ -67,6 +67,8 @@ test = [
   "rich",
   'typing-extensions; python_version < "3.11"',
   "wheel",
+  "griffe",
+  "flake8",
 ]
 toml = [
 ]

src/setuptools_scm/_integration/dump_version.py

@@ -16,7 +16,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple", "__commit_id__", "commit_id"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING: