Skip to content

Mention gRPC client and server code generation #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pkosiec merged 2 commits into from
Feb 28, 2022
Merged

Mention gRPC client and server code generation #110

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8d3e52
Mention gRPC client and server code generation
pkosiec Feb 24, 2022
ea47870
Mention plugins for `protoc`
pkosiec Feb 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions community/development/development-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down