Categorygithub.com/github/proto-gen-go
repositorypackage
1.6.0
Repository: https://github.com/github/proto-gen-go.git
Documentation: pkg.go.dev

# README

proto-gen-go

Docker

This tool is a thin wrapper around protoc, the protocol compiler. It makes it easy to reliably generate and update Go definitions for messages and services defined in .proto files. It uses a docker container with explicitly versioned dependencies to ensure maximum reproducibility and minimum side effects.

In your Go project's proto directory, add a gen.go file with the following contents:

package proto
//go:generate sh -c "go run github.com/github/[email protected] [flags] [--] [protoc flags] [proto files]"

(The go run module@version command requires Go 1.17 or later.)

Now, when you run go generate in your proto directory, the script will re-run the protocol compiler on all .proto files, and generate go files into the obvious relative locations. Commit them along with your source code.