diff --git a/community/development/development-guide.md b/community/development/development-guide.md index 777570b..c70a41b 100644 --- a/community/development/development-guide.md +++ b/community/development/development-guide.md @@ -289,6 +289,22 @@ Each time the GraphQL schema changes, you need to update generated resources. To make gen-graphql-resources ``` +### Generate code from Protocol Buffers schema + +This project uses the [`protoc`](https://github.com/protocolbuffers/protobuf) compiler, which generates Go code both for gRPC server and client, based on Protocol Buffers schema. + +The `protoc` compiler uses the following plugins: +- [`protoc-gen-go`](https://pkg.go.dev/google.golang.org/protobuf/cmd/protoc-gen-go) +- [`protoc-gen-go-grpc`](https://pkg.go.dev/google.golang.org/grpc/cmd/protoc-gen-go-grpc) + +In Capact project we have one Protocol Buffers schema for [Storage Backend](https://github.com/capactio/capact/tree/main/pkg/hub/api/grpc/storage_backend.proto) Hub extension. + +Each time the Protocol Buffers schema changes, you need to regenerate Go code. To do this, execute: + +```bash +make gen-grpc-resources +``` + ### Generate documentation For the Capact CLI development we use [Cobra](https://github.com/spf13/cobra) library. The documentation for the CLI is generated automatically based on CLI commands code.