feat(CI): Enforce charts metadata backward compatibility check

[geido]

SUMMARY

Introducing a new workflow to check for changes on transformProps and controlPanel files for plugins. We have identified issues with changes to charts props and controls that are not backward compatible causing disruption for charts and dashboards. This is meant to be a temporary / low-effort solution to mitigate the impact going forward. A better and longer term solution would be to implement proper metadata versioning.

Why a Github workflow?

• All plugins follow the same structure, so changes to transformProps and controlPanel often indicate that modifications to the metadata may have been introduced. While this is not always the case, adding an extra check when altering such a critical part of the codebase is a prudent measure.
• Each chart relies on its own specific metadata. Enforcing backward compatibility checks at the chart level would require dedicated unit tests for each case. However, developers might be inclined to modify these tests to accommodate changes, rather than using them as a true validation mechanism—ultimately reducing their effectiveness.
• Introducing a check during CI runs is a more explicit and visible way to enforce backward compatibility. It demands deliberate attention from the developer and encourages proper validation before proceeding.

If any transformProps or controlPanel get touched, CI should re-run with a label validation:backward-compatible to confirm backward-compatibility.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

CI should pass

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

• Has associated issue:
• Required feature flags:
• Changes UI
• Includes DB Migration (follow approval process in SIP-59)
  • Migration is atomic, supports rollback & is backwards-compatible
  • Confirm DB migration upgrade and downgrade tested
  • Runtime estimates and downtime expectations provided
• Introduces new feature or API
• Removes existing feature or API

[korbit-ai]

Based on your review schedule, I'll hold off on reviewing this PR until it's marked as ready for review. If you'd like me to take a look now, comment /korbit-review.

Your admin can change your review schedule in the Korbit Console

[korbit-ai]

I've completed my review and didn't find any issues.

Check out our docs on how you can make Korbit work best for you and your team.

Loving Korbit!? Share us on LinkedIn Reddit and X

[kgabryje]

Not an expert on github workflows so I'm not diving into the code, but I like the idea as a temporary solution for ensuring backward compatibility

[msyavuz]

Looks good to me with a small nit

[msyavuz]

I think this runs diff against master but the base might be different?

[rusackas]

We might not need a whole new action for this. You could just add a few filenames to this file. However, that would apply to all branches, I believe, so I'm not sure if that solves the issue for you.

[geido]

We might not need a whole new action for this. You could just add a few filenames to this file. However, that would apply to all branches, I believe, so I'm not sure if that solves the issue for you.

This is great. Let me change it!