Skip to content

Add Protocol Buffers Setup Details #8551

@Jenkins-J

Description

@Jenkins-J

What is the problem you're trying to solve

The current documentation on building the development environment describes how to install protoc, but leaves out the following details:

  • Additional protocol buffer dependencies must be added to /usr/local/include/ (Ex. google/rpc/status.proto)
  • For protocol buffer generation to succeed, the containerd project must be under the GOPATH as Go modules are not accounted for as stated here.

Describe the solution you'd like

The above details should be documented in BULDING.md. The protocol buffer setup script (script/setup/install-protobuf) can also be mentioned, making it faster for new contributors to set up the proper versions of protocol buffer tools and dependencies.

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions