From 5e5418399a44983060b31bc01566e61fa36433e5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Edgar=20Ram=C3=ADrez-Mondrag=C3=B3n?= <edgarrm358@gmail.com>
Date: Tue, 16 Jul 2024 17:03:19 -0600
Subject: [PATCH] chore: Use `griffe` to catch breaking API changes

---
 .github/workflows/api-changes.yml | 52 +++++++++++++++++++++++++++++++
 .github/workflows/constraints.txt |  1 +
 noxfile.py                        | 16 ++++++++++
 3 files changed, 69 insertions(+)
 create mode 100644 .github/workflows/api-changes.yml

diff --git a/.github/workflows/api-changes.yml b/.github/workflows/api-changes.yml
new file mode 100644
index 0000000000..9cbae58431
--- /dev/null
+++ b/.github/workflows/api-changes.yml
@@ -0,0 +1,52 @@
+name: API Changes
+
+on:
+  pull_request:
+    paths:
+    - singer_sdk/**
+    - .github/workflows/api-changes.yml
+    - CHANGELOG.md
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+permissions:  # added using https://github.com/step-security/secure-repo
+  contents: read
+
+jobs:
+  check-api-changes:
+    name: Check API Changes
+    runs-on: ubuntu-latest
+    env:
+      NOXSESSION: api
+    steps:
+    - name: Check out the repository
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.12
+
+    - name: Install tools
+      env:
+        PIP_CONSTRAINT: ${{ github.workspace }}/.github/workflows/constraints.txt
+      run: |
+        python -Im pip install -U pip
+        pipx install griffe nox
+        pipx list
+
+    - name: Set REF
+      id: set-ref
+      if: always() && !startsWith(github.head_ref, 'release/')
+      run: |
+        echo "ref=${{ github.event.pull_request.base.sha }}" >> $GITHUB_OUTPUT
+
+    # Check API against the latest commit on the base branch
+    - name: Run Nox
+      run: |
+        nox -- ${{ steps.set-ref.outputs.ref }}
diff --git a/.github/workflows/constraints.txt b/.github/workflows/constraints.txt
index 9677e3ce12..70fa9ec0b6 100644
--- a/.github/workflows/constraints.txt
+++ b/.github/workflows/constraints.txt
@@ -1,3 +1,4 @@
+griffe==0.48.0
 pip==24.1.2
 poetry==1.8.3
 poetry-plugin-export==1.8.0
diff --git a/noxfile.py b/noxfile.py
index 1242828220..f1b349aa96 100644
--- a/noxfile.py
+++ b/noxfile.py
@@ -279,3 +279,19 @@ def version_bump(session: Session) -> None:
         "bump",
         *args,
     )
+
+
+@nox.session(name="api")
+def api_changes(session: nox.Session) -> None:
+    """Check for API changes."""
+    args = [
+        "griffe",
+        "check",
+        "citric",
+        "-s=src",
+    ]
+
+    if session.posargs:
+        args.append(f"-a={session.posargs[0]}")
+
+    session.run(*args, external=True)