Skip to content

Commit

Permalink
fix(docs): add note about protoc dependency and version (#10895)
Browse files Browse the repository at this point in the history
Add a note about protoc being required, and a note about which versions are known to work.

Signed-off-by: Greg Sheremeta <gshereme@redhat.com>
  • Loading branch information
gregsheremeta authored Jul 25, 2024
1 parent 08185e7 commit d911c8b
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions kubernetes_platform/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit d911c8b

Please sign in to comment.