https://github.com/chainguard-dev/sdk
Public SDK for integrating with the Chainguard platform
https://github.com/chainguard-dev/sdk
audit
Last synced: about 1 month ago
JSON representation
Public SDK for integrating with the Chainguard platform
- Host: GitHub
- URL: https://github.com/chainguard-dev/sdk
- Owner: chainguard-dev
- License: apache-2.0
- Created: 2023-09-08T22:36:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-01-24T01:05:38.000Z (about 2 months ago)
- Last Synced: 2026-01-24T09:19:02.958Z (about 2 months ago)
- Topics: audit
- Language: Go
- Homepage:
- Size: 3.23 MB
- Stars: 1
- Watchers: 2
- Forks: 21
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SDK
This repository contains the public [gRPC](https://grpc.io/) 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.
```shell
./hack/update-codegen.sh
```
### Prerequisites
Install `protoc` [v5.29.3](https://github.com/protocolbuffers/protobuf/releases/download/v29.3/protoc-29.3-linux-x86_64.zip): https://grpc.io/docs/protoc-installation/
Example for MacOS:
```shell
brew install protobuf
```
We currently require `protoc` v5.29.3.
Install `protoc` codegen dependencies:
```shell
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.