From 10bb3561f5dde60d3ae196e3bd7cd1ffc2ef1228 Mon Sep 17 00:00:00 2001 From: Arve Knudsen Date: Mon, 22 Mar 2021 19:28:33 +0100 Subject: [PATCH] Docs: Document upgrading of protobuf (#32227) * Docs: Document upgrading of protobuf Signed-off-by: Arve Knudsen * Document protobuf re-compiling Signed-off-by: Arve Knudsen * Update CODEOWNERS Signed-off-by: Arve Knudsen --- .github/CODEOWNERS | 1 + .../backend/upgrading-dependencies.md | 22 +++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 contribute/engineering/backend/upgrading-dependencies.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 7d19f1d9829..b27b558047d 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -34,6 +34,7 @@ go.sum @grafana/backend-platform # Backend code docs /contribute/style-guides/backend.md @grafana/backend-platform /contribute/architecture/backend @grafana/backend-platform +/contribute/engineering/backend @grafana/backend-platform /e2e @grafana/grafana-frontend-platform /packages @grafana/grafana-frontend-platform diff --git a/contribute/engineering/backend/upgrading-dependencies.md b/contribute/engineering/backend/upgrading-dependencies.md new file mode 100644 index 00000000000..c56e293d574 --- /dev/null +++ b/contribute/engineering/backend/upgrading-dependencies.md @@ -0,0 +1,22 @@ +# Upgrading dependencies + +Notes on upgrading various backend dependencies. + +# Protobuf + +When upgrading the [protobuf](http://github.com/golang/protobuf) library in Grafana and the plugin SDK, +you typically also want to upgrade your protobuf compiler toolchain and re-compile protobuf files: + +``` +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