Ensure generated protobuf matches the repo
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 11.5k
- Forks
- 1.4k
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 53
Description
PR #3241 revealed that the state of master (.proto files and version of github.com/golang/protobuf) did not match the generated .pb.go code.
Modify CI, or some build script, to ensure the repo's generated code is always consistent with the rest of the repo. Essentially, running bin/protoc-go.sh should never dirty the repo.
More context:
https://github.com/linkerd/linkerd2/pull/3241#issuecomment-520989937
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with bin/protoc-go.sh and the repository's CI or build configuration. Compare the .proto files, the github.com/golang/protobuf version, and generated .pb.go code, then run bin/protoc-go.sh to verify it leaves the repository clean. Done means CI or the build process catches any mismatch consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- build-system, ci-cd
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100