From 244cdfa6a31ee358ec1380633d92284b0797e332 Mon Sep 17 00:00:00 2001
From: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Date: Wed, 1 Jul 2026 18:00:14 +0000
Subject: [PATCH 1/2] ci: label breaking api changes from committed diffs
 Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>

---
 .github/workflows/detect-api-changes.yml | 44 ++++++++++++++++++++++--
 docs/content/internals/stability.md      |  3 +-
 2 files changed, 44 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/detect-api-changes.yml b/.github/workflows/detect-api-changes.yml
index e529e2ec7..4d2b3a211 100644
--- a/.github/workflows/detect-api-changes.yml
+++ b/.github/workflows/detect-api-changes.yml
@@ -30,6 +30,7 @@ jobs:
           REPO: ${{ github.repository }}
         run: |
           MARKER="<!-- api-change-detector -->"
+          BREAKING_LABEL="breaking-api-change"
 
           api_files=$(gh api "repos/${REPO}/pulls/${PR_NUMBER}/files" --paginate \
             --jq '.[] | select(.filename | startswith("docs/apidiffs/current_vs_latest/")) | .filename')
@@ -40,6 +41,7 @@ jobs:
           if [[ -z "$api_files" ]]; then
             echo "No API diff files changed."
             gh pr edit "$PR_NUMBER" --repo "$REPO" --remove-label "api-change" 2>/dev/null || true
+            gh pr edit "$PR_NUMBER" --repo "$REPO" --remove-label "$BREAKING_LABEL" 2>/dev/null || true
             if [[ -n "$comment_id" ]]; then
               gh api --method DELETE "repos/${REPO}/issues/comments/${comment_id}"
             fi
@@ -57,7 +59,44 @@ jobs:
             | sort \
             | sed 's/^/- /')
 
-          body=$(cat <<EOF
+          HEAD_SHA=$(gh api "repos/${REPO}/pulls/${PR_NUMBER}" --jq .head.sha)
+          breaking_files=()
+          while IFS= read -r file; do
+            [[ -z "$file" ]] && continue
+            content=$(gh api \
+              -H "Accept: application/vnd.github.raw+json" \
+              "repos/${REPO}/contents/${file}?ref=${HEAD_SHA}")
+            if grep -Eq '^[[:space:]]*(\*\*\*!|---!|\+\+\+!)' <<<"$content"; then
+              breaking_files+=("$file")
+            fi
+          done <<<"$api_files"
+
+          if [[ ${#breaking_files[@]} -gt 0 ]]; then
+            gh pr edit "$PR_NUMBER" --repo "$REPO" --add-label "$BREAKING_LABEL"
+            breaking_modules=$(printf '%s\n' "${breaking_files[@]}" \
+              | sed 's|docs/apidiffs/current_vs_latest/||' \
+              | sed 's|\.txt$||' \
+              | sort \
+              | sed 's/^/- /')
+            body=$(cat <<EOF
+          ${MARKER}
+          ## :warning: Breaking API changes detected — maintainer review required
+
+          This PR modifies the published API diff for the following module(s):
+
+          ${modules}
+
+          The committed API diff contains breaking-change markers for:
+
+          ${breaking_modules}
+
+          Please review the changes in \`docs/apidiffs/current_vs_latest/\` carefully before approving.
+          EOF
+            )
+          else
+            gh pr edit "$PR_NUMBER" --repo "$REPO" --remove-label "$BREAKING_LABEL" 2>/dev/null || true
+
+            body=$(cat <<EOF
           ${MARKER}
           ## :warning: API changes detected — maintainer review required
 
@@ -67,7 +106,8 @@ jobs:
 
           Please review the changes in \`docs/apidiffs/current_vs_latest/\` carefully before approving.
           EOF
-          )
+            )
+          fi
 
           if [[ -n "$comment_id" ]]; then
             gh api --method PATCH "repos/${REPO}/issues/comments/${comment_id}" \
diff --git a/docs/content/internals/stability.md b/docs/content/internals/stability.md
index a447c5068..e9487c39a 100644
--- a/docs/content/internals/stability.md
+++ b/docs/content/internals/stability.md
@@ -28,4 +28,5 @@ The baseline version is tracked in `pom.xml` and updated by Renovate; the publis
 are stored under `docs/apidiffs/`.
 
 Pull requests that change `docs/apidiffs/current_vs_latest/` are automatically labeled
-`api-change` for additional maintainer review.
+`api-change` for additional maintainer review. If the committed API diff contains breaking-change
+markers, the pull request is also labeled `breaking-api-change`.

From a99d4ca9cf763c50c991e3824bb433ae11e9f4a3 Mon Sep 17 00:00:00 2001
From: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Date: Thu, 2 Jul 2026 07:01:09 +0000
Subject: [PATCH 2/2] fix: address review feedback on api change labels
 Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>

---
 .github/workflows/detect-api-changes.yml | 2 +-
 docs/content/internals/stability.md      | 3 ++-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/detect-api-changes.yml b/.github/workflows/detect-api-changes.yml
index 4d2b3a211..f0de28c7a 100644
--- a/.github/workflows/detect-api-changes.yml
+++ b/.github/workflows/detect-api-changes.yml
@@ -64,7 +64,7 @@ jobs:
           while IFS= read -r file; do
             [[ -z "$file" ]] && continue
             content=$(gh api \
-              -H "Accept: application/vnd.github.raw+json" \
+              -H "Accept: application/vnd.github.raw" \
               "repos/${REPO}/contents/${file}?ref=${HEAD_SHA}")
             if grep -Eq '^[[:space:]]*(\*\*\*!|---!|\+\+\+!)' <<<"$content"; then
               breaking_files+=("$file")
diff --git a/docs/content/internals/stability.md b/docs/content/internals/stability.md
index e9487c39a..d960c7ffa 100644
--- a/docs/content/internals/stability.md
+++ b/docs/content/internals/stability.md
@@ -29,4 +29,5 @@ are stored under `docs/apidiffs/`.
 
 Pull requests that change `docs/apidiffs/current_vs_latest/` are automatically labeled
 `api-change` for additional maintainer review. If the committed API diff contains breaking-change
-markers, the pull request is also labeled `breaking-api-change`.
+markers such as `***!`, `---!`, or `+++!`, the pull request is also labeled
+`breaking-api-change`.