Skip to content

ci: pin latest-Grafana compatibility check to our supported version#155

Merged
alexinthesky merged 1 commit into
mainfrom
claude/amazing-roentgen-28785f
Jul 21, 2026
Merged

ci: pin latest-Grafana compatibility check to our supported version#155
alexinthesky merged 1 commit into
mainfrom
claude/amazing-roentgen-28785f

Conversation

@alexinthesky

@alexinthesky alexinthesky commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • The "Latest Grafana API compatibility check" workflow (is-compatible.yml) uses grafana/plugin-actions/is-compatible, which defaults to comparing our plugin against @grafana/*@latest. @grafana/runtime just published v13.1.1, which flags config as "changed" in every file that imports it (AppConfig.tsx, backendSessionClient.ts, useChat.ts, sessionShare.ts), turning this check red on every PR going forward.
  • I diffed the actual .d.ts between @grafana/runtime@12.4.5 (what we ship) and 13.1.1: the only changes to config are an unused regionalFormat field removal and a few additive optional fields, nothing this plugin's config.bootData.user.orgId/orgName/getBackendSrv() usage touches. So this is a false positive from comparing against a moving @latest target, not a real incompatibility.
  • This is not a required merge check (only "Build, lint and unit tests" is required per ruleset 11741477), so it was not blocking, but it would stay red indefinitely without this fix.

Fix

Pin the action's targets input to our currently-supported exact versions (@grafana/data@12.4.5,@grafana/ui@12.4.5,@grafana/runtime@12.4.5,@grafana/schema@12.4.5) instead of the action's unpinned default. Verified locally with npx @grafana/levitate is-compatible that this now reports fully compatible. Bump this pin deliberately alongside package.json's @grafana/* versions whenever we upgrade.

Test plan

  • Ran npx @grafana/levitate@latest is-compatible --path ./src/module.tsx --target @grafana/data@12.4.5,@grafana/ui@12.4.5,@grafana/runtime@12.4.5,@grafana/schema@12.4.5 locally, reports compatible
  • Confirm the "Latest Grafana API compatibility check" workflow passes on this PR

🤖 Generated with Claude Code


Note

Low Risk
CI-only workflow input change with no runtime or application code impact.

Overview
The Latest Grafana API compatibility check workflow now passes explicit targets to grafana/plugin-actions/is-compatible instead of relying on the action default (@grafana/*@latest).

Compatibility is checked against @grafana/data, @grafana/ui, @grafana/runtime, and @grafana/schema at 12.4.5, matching what the plugin is built and shipped against. Comments in the workflow call out that this pin should be bumped deliberately when package.json @grafana/* versions are upgraded.

This stops the check from failing on unrelated upstream releases (e.g. Grafana 13.x) that surface false positives while the plugin still targets Grafana 12.4.x.

Reviewed by Cursor Bugbot for commit 6bccaf0. Bugbot is set up for automated code reviews on this repo. Configure here.

The is-compatible action defaults to comparing against @grafana/*@latest,
so it goes red on every upstream release regardless of whether the API
surface we actually use changed. Pin targets to the @grafana/*@12.4.5 we
currently ship against; bump deliberately alongside package.json when we
upgrade.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@alexinthesky
alexinthesky merged commit 40b9ce1 into main Jul 21, 2026
17 checks passed
@alexinthesky
alexinthesky deleted the claude/amazing-roentgen-28785f branch July 21, 2026 13:40
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