Skip to content

ci: detect api changes from committed diffs#2258

Open
zeitlinger wants to merge 1 commit into
mainfrom
ci/otel-style-api-diff
Open

ci: detect api changes from committed diffs#2258
zeitlinger wants to merge 1 commit into
mainfrom
ci/otel-style-api-diff

Conversation

@zeitlinger

Copy link
Copy Markdown
Member

Summary

  • remove the extra API-diff workflow gate that failed on any incompatible japicmp entry in the raw XML
  • make committed docs/apidiffs/current_vs_latest/ the authoritative PR review artifact, matching the OpenTelemetry Java model
  • add a separate workflow that labels PRs as api-change and leaves a maintainer-review comment when those committed API diff files change
  • update the stability docs to describe the new flow

Why

The previous label-based override only waived a single PR while CI still compared every future PR against the same released baseline. That meant one accepted breaking change kept poisoning unrelated follow-up PRs. The OTel Java pattern avoids that by reviewing and carrying forward the checked-in API diff files instead of keeping a second persistent incompatible-change gate.

Testing

  • mise run lint:fix

Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
@zeitlinger zeitlinger marked this pull request as ready for review June 26, 2026 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant