feat: Add StableApi marker and API diff check#2168
Open
zeitlinger wants to merge 1 commit into
Open
Conversation
zeitlinger
changed the title
zeitlinger
force-pushed
the
api-diff-baseline-japicmp
branch
2 times, most recently
from
cbd01a5 to
e296cbd
Compare
zeitlinger
force-pushed
the
api-diff-baseline-japicmp
branch
from
e296cbd to
974e23a
Compare
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
zeitlinger
force-pushed
the
api-diff-baseline-japicmp
branch
from
974e23a to
3431634
Compare
jaydeluca
approved these changes
Jun 1, 2026
| baseline_version: | ||
| description: Version to compare the PR artifacts against | ||
| required: false | ||
| default: "1.5.1" |
Collaborator
There was a problem hiding this comment.
how should we keep this up to date? should we create an issue to add a post-release step automation?
| @@ -0,0 +1,325 @@ | |||
| # Stable API rationale | |||
Collaborator
There was a problem hiding this comment.
this was good to have as review context, but we can probably remove at some point
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
2 participants
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
@StableApias the opt-in marker for published Java APImise run api-diffusing japicmp against the configured baselinedocs/stable-api-rationale.mdNotes
This is the bootstrap PR for the annotation-based API surface. Since
1.5.1does not contain@StableApi, the first diff is noisy and mostly shows the seeded API surface as new. After arelease contains the annotations, future diffs should be normal compatibility diffs.
The workflow does not post PR comments or upload artifacts. If the check fails, run this locally:
Reports are written to
**/target/japicmp/*.Intentional incompatible changes can be accepted by adding the PR label
breaking-api-change-accepted.Validation
mise run api-diffmise run buildmise run lint