From d911c8b73b49cd0a4ffda132f494f31d0d48095a Mon Sep 17 00:00:00 2001 From: Greg Sheremeta Date: Thu, 25 Jul 2024 16:57:54 -0400 Subject: [PATCH] fix(docs): add note about protoc dependency and version (#10895) Add a note about protoc being required, and a note about which versions are known to work. Signed-off-by: Greg Sheremeta --- kubernetes_platform/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/kubernetes_platform/README.md b/kubernetes_platform/README.md index 2efc3876bda..5cb0872f46e 100644 --- a/kubernetes_platform/README.md +++ b/kubernetes_platform/README.md @@ -2,6 +2,11 @@ Contains protos, non-proto Python library code, and tools for generating Go and Python proto library code. +## Dependencies +You need to have `protoc` installed. You can find the releases [here](https://github.com/protocolbuffers/protobuf/releases). + +If you get an error `ImportError: cannot import name 'runtime_version' from 'google.protobuf'` when trying to import kfp-kubernetes that you've built with protoc, you're using a protoc that's too new. Version 21.12 is known to work for compiling the python protos. Version 27.1 is known to produce this error. + ## Generate Python proto code (alongside non-proto library code) Python proto code should be updated prior to releasing the package. For this reason, bumping the version number is included in the instructions.