Skip to content

Commit d4d1f4e

Browse files
marefrwbrowne
andauthored
Chore: Protobuf guide and re-generate (#971)
Co-authored-by: Will Browne <[email protected]>
1 parent 0f6f235 commit d4d1f4e

File tree

3 files changed

+17
-4
lines changed

3 files changed

+17
-4
lines changed

contribute/developer-guide.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,22 @@ mage lint
4444

4545
A prerequisite is to have [protoc](http://google.github.io/proto-lens/installing-protoc.html) installed and available in your path.
4646

47-
Next, you need to have [protoc-gen-go](https://github.com/golang/protobuf/tree/v1.3.4#installation) installed and available in your path. It's very important that you match the version specified of `github.com/golang/protobuf` in [go.mod](go.mod) file, as of this writing it's v1.3.4.
47+
Next, you need to have [protoc-gen-go](https://github.com/protocolbuffers/protobuf-go/tree/master/cmd/protoc-gen-go) and [protoc-gen-grpc-go](https://pkg.go.dev/google.golang.org/grpc/cmd/protoc-gen-go-grpc) installed and available in your path. It's very important that you match the `protoc-gen-go` version specified of `google.golang.org/protobuf` in [go.mod](../go.mod), which at the time of writing is v1.33.0.
4848

49+
To install protoc-gen-go (version should automatically be taken from the go.mod):
50+
51+
```shell
52+
go install google.golang.org/protobuf/cmd/protoc-gen-go
53+
```
54+
55+
To install protoc-gen-go-grpc (latest version as of this writing is v1.3.0):
56+
```shell
57+
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
4958
```
59+
60+
To compile the protobuf:
61+
62+
```shell
5063
mage protobuf
5164
```
5265

genproto/pluginv2/backend.pb.go

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

genproto/pluginv2/backend_grpc.pb.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)