ci: pin latest-Grafana compatibility check to our supported version#155
Merged
Conversation
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>
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
is-compatible.yml) usesgrafana/plugin-actions/is-compatible, which defaults to comparing our plugin against@grafana/*@latest.@grafana/runtimejust publishedv13.1.1, which flagsconfigas "changed" in every file that imports it (AppConfig.tsx,backendSessionClient.ts,useChat.ts,sessionShare.ts), turning this check red on every PR going forward..d.tsbetween@grafana/runtime@12.4.5(what we ship) and13.1.1: the only changes toconfigare an unusedregionalFormatfield removal and a few additive optional fields, nothing this plugin'sconfig.bootData.user.orgId/orgName/getBackendSrv()usage touches. So this is a false positive from comparing against a moving@latesttarget, not a real incompatibility.11741477), so it was not blocking, but it would stay red indefinitely without this fix.Fix
Pin the action's
targetsinput 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 withnpx @grafana/levitate is-compatiblethat this now reports fully compatible. Bump this pin deliberately alongsidepackage.json's@grafana/*versions whenever we upgrade.Test plan
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.5locally, reports compatible🤖 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
targetstografana/plugin-actions/is-compatibleinstead of relying on the action default (@grafana/*@latest).Compatibility is checked against
@grafana/data,@grafana/ui,@grafana/runtime, and@grafana/schemaat12.4.5, matching what the plugin is built and shipped against. Comments in the workflow call out that this pin should be bumped deliberately whenpackage.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.