SDK

This repository contains the public gRPC protos supporting our services and packages to ease integration with the Chainguard platform.

Updating *.proto files

After updating a *.proto you'll need to update the corresponding generated go code.

./hack/update-codegen.sh

Prerequisites

Install protoc v5.29.3: https://grpc.io/docs/protoc-installation/

Example for MacOS:

brew install protobuf

We currently require protoc v5.29.3.

Install protoc codegen dependencies:

go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.34.2
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.5.1
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@v2.22.0
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@v2.22.0

Breaking Changes

While we make every effort to maintain backward compatibility and avoid breaking changes, we cannot guarantee that future updates to this SDK will be entirely non-breaking. As our platform evolves and new features are added, some modifications to the API surface may be necessary. We recommend pinning to specific versions in production environments and thoroughly testing updates before deployment.