Skip to content

Commit

Permalink
docs: Update to mention buf replacing protoc.sh
Browse files Browse the repository at this point in the history 
Signed-off-by: Manuel Mendez <[email protected]>
  • Loading branch information
@mmlb
mmlb committed Oct 6, 2021
1 parent cb6e62d commit b4465b6
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -177,8 +177,11 @@ It has a base server that implements the API.
### protos

The `protos` package contains all the protobuf files used by the gRPC server.
Handling of protobuf deps and generating the go files are both handled by the [protoc.sh](./protos/protoc.sh) script.
Also, both `go`, and `protoc` are required by `protoc.sh`.
Handling of protobuf deps and generating the go files are both handled [buf] via `make pbfiles`.
The protubuf/grpc files are not generated as part of the build pipeline to keep builds fast.
CI will ensure generated files are up to date.

[buf]: https://buf.build/

```
.
Expand Down

0 comments on commit b4465b6

Please sign in to comment.