ci: label breaking api changes from committed diffs - #2265
Merged
Conversation
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the API-diff review workflow by detecting “breaking change” markers inside committed API diff artifacts under docs/apidiffs/current_vs_latest/ and surfacing them via an additional PR label, plus documenting the behavior in the stability docs.
Changes:
- Add
breaking-api-changelabel automation when committed API diff files contain***!,---!, or+++!markers. - Update the API-change PR comment body to distinguish breaking vs non-breaking API diff changes.
- Document the breaking-label flow in internal stability documentation.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/content/internals/stability.md | Documents the additional breaking-api-change label behavior for API diffs. |
| .github/workflows/detect-api-changes.yml | Implements breaking-marker scanning in committed API diffs and applies/removes the new label accordingly. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
jaydeluca
approved these changes
Jul 2, 2026
zeitlinger
added a commit
that referenced
this pull request
Jul 2, 2026
Blocked by #2265 - to make sure that breaking api change is correctly flagged ## Summary - deprecate the `OpenTelemetryExporter(MetricReader)` constructor instead of treating it as stable API - make the builder entry points the stable surface for `OpenTelemetryExporter` - grandfather the already-accepted constructor removal in the API diff workflow so unrelated PRs stop inheriting the failure on `main` ## Testing - mise run lint:fix - mise run build - ./mvnw -B verify -pl prometheus-metrics-exporter-opentelemetry,prometheus-metrics-exporter-opentelemetry-shaded -am -P 'api-diff,!examples-and-integration-tests' -DskipTests -Dcoverage.skip=true -Dcheckstyle.skip=true -Dwarnings=-nowarn
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/apidiffs/current_vs_latest/filesbreaking-api-changelabel when committed API diffs contain***!,---!, or+++!markersWhy
The committed API diff files are the review artifact. Labeling PRs with
breaking-api-changemakes breaking changes visible in the PR UI without requiring a separate acceptance label.Testing