grafana/contribute/backend/upgrading-dependencies.md
Marcus Efraimsson 41b29ff93c
Chore: Migrate to use buf for protobuf generation (#87407)
* Chore: Migrate to use buf for protobuf generation

* fix codeowners

* fixes after review

* docs/tooling for installing buf

* add back codeowners

* Update upgrading-dependencies.md

Co-authored-by: Giuseppe Guerra <giuseppe.guerra@grafana.com>

* sdk v0.229.0

---------

Co-authored-by: Giuseppe Guerra <giuseppe.guerra@grafana.com>
2024-05-08 15:42:40 +02:00

898 B

Upgrading dependencies

Notes on upgrading various backend dependencies.

Protobuf

When upgrading the protobuf library in Grafana and the plugin SDK, you typically also want to upgrade your protobuf compiler toolchain and re-compile protobuf files.

Note: You need Buf CLI installed and availabile in your path, see https://buf.build/docs/installation for instructions.

Re-compile protobuf files in grafana and the plugin SDK:

cd $GRAFANA
make protobuf
cd $GRAFANA_PLUGIN_SDK_GO
mage protobuf

After upgrading the protobuf dependency in Grafana and the plugin SDK, it might be wise to test that things still work, before making corresponding PRs:

  • Test a plugin built with upgraded SDK on upgraded Grafana
  • Test a plugin built with non-upgraded SDK on upgraded Grafana
  • Test a plugin built with upgraded SDK on non-upgraded Grafana