Docs: Document upgrading of protobuf (#32227)

* Docs: Document upgrading of protobuf

Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>

* Document protobuf re-compiling

Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>

* Update CODEOWNERS

Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
This commit is contained in:
Arve Knudsen 2021-03-22 19:28:33 +01:00 committed by GitHub
parent 3ef9cac640
commit 10bb3561f5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 0 deletions

1
.github/CODEOWNERS vendored
View File

@ -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

View File

@ -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