build(proto): switch to buf and gate gen on breaking check #586
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| on: | ||
| push: | ||
| paths: | ||
| - 'proto/**' | ||
| - '.github/workflows/proto.yml' | ||
| pull_request: | ||
| paths: | ||
| - 'proto/**' | ||
| - '.github/workflows/proto.yml' | ||
|
|
||
| name: Proto | ||
| permissions: | ||
| contents: read | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| proto: | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| BUF_VERSION: 1.55.1 | ||
| PROTOC_GEN_GO_VERSION: v1.36.11 | ||
| PROTOC_GEN_GO_GRPC_VERSION: v1.6.1 | ||
| steps: | ||
| - uses: actions/checkout@v6 | ||
| with: | ||
| fetch-depth: 0 | ||
| - name: Fetch main for breaking baseline | ||
| if: github.ref != 'refs/heads/main' | ||
| run: git fetch --no-tags --prune origin +refs/heads/main:refs/remotes/origin/main | ||
| - uses: actions/setup-go@v6 | ||
| with: | ||
| go-version-file: 'go.mod' | ||
| - name: Install buf | ||
| run: go install github.com/bufbuild/buf/cmd/buf@v${{ env.BUF_VERSION }} | ||
| - name: Install protoc-gen-go | ||
| run: go install google.golang.org/protobuf/cmd/protoc-gen-go@${{ env.PROTOC_GEN_GO_VERSION }} | ||
| - name: Install protoc-gen-go-grpc | ||
| run: go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@${{ env.PROTOC_GEN_GO_GRPC_VERSION }} | ||
| - name: buf breaking (against main) | ||
| if: github.ref != 'refs/heads/main' | ||
| working-directory: proto | ||
| run: buf breaking --against '../.git#subdir=proto,ref=refs/remotes/origin/main' | ||
| - name: buf generate | ||
| working-directory: proto | ||
| run: buf generate | ||
| - name: Fail on regenerated diff | ||
| run: | | ||
| # intent-to-add surfaces newly generated .pb.go that would | ||
| # otherwise be invisible to `git diff` (adding a .proto without | ||
| # committing its generated .pb.go must fail this gate). | ||
| git add -N proto/ | ||
| if ! git diff --exit-code -- proto/; then | ||
| echo "::error::Generated proto files differ from committed output. Run 'make -C proto gen' and commit the result." | ||
| exit 1 | ||
| fi | ||
| - name: go build | ||
| run: go build ./... | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,63 @@ | ||
| BUF_VERSION := 1.55.1 | ||
| PROTOC_GEN_GO_VERSION := 1.36.11 | ||
| PROTOC_GEN_GO_GRPC_VERSION := 1.6.1 | ||
|
|
||
| BUF ?= buf | ||
| # BREAKING_AGAINST lets callers override the auto-detected baseline. | ||
| BREAKING_AGAINST ?= | ||
|
|
||
| .PHONY: all gen check-tools breaking | ||
|
|
||
| all: gen | ||
|
|
||
| check-tools: | ||
| @command -v $(BUF) >/dev/null 2>&1 || { \ | ||
| echo "buf not found; install with:"; \ | ||
| echo " go install github.com/bufbuild/buf/cmd/buf@v$(BUF_VERSION)"; \ | ||
| exit 1; \ | ||
| } | ||
| @installed=$$($(BUF) --version 2>/dev/null); \ | ||
| if [ "$$installed" != "$(BUF_VERSION)" ]; then \ | ||
| echo "buf version mismatch: expected $(BUF_VERSION), got $$installed"; \ | ||
| echo "install with: go install github.com/bufbuild/buf/cmd/buf@v$(BUF_VERSION)"; \ | ||
| exit 1; \ | ||
| fi | ||
| @command -v protoc-gen-go >/dev/null 2>&1 || { \ | ||
| echo "protoc-gen-go not found; install with:"; \ | ||
| echo " go install google.golang.org/protobuf/cmd/protoc-gen-go@v$(PROTOC_GEN_GO_VERSION)"; \ | ||
| exit 1; \ | ||
| } | ||
| @installed=$$(protoc-gen-go --version 2>/dev/null); \ | ||
| if [ "$$installed" != "protoc-gen-go v$(PROTOC_GEN_GO_VERSION)" ]; then \ | ||
| echo "protoc-gen-go version mismatch: expected v$(PROTOC_GEN_GO_VERSION), got $$installed"; \ | ||
| echo "install with: go install google.golang.org/protobuf/cmd/protoc-gen-go@v$(PROTOC_GEN_GO_VERSION)"; \ | ||
| exit 1; \ | ||
| fi | ||
| @command -v protoc-gen-go-grpc >/dev/null 2>&1 || { \ | ||
| echo "protoc-gen-go-grpc not found; install with:"; \ | ||
| echo " go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v$(PROTOC_GEN_GO_GRPC_VERSION)"; \ | ||
| exit 1; \ | ||
| } | ||
| @installed=$$(protoc-gen-go-grpc --version 2>/dev/null); \ | ||
| if [ "$$installed" != "protoc-gen-go-grpc $(PROTOC_GEN_GO_GRPC_VERSION)" ]; then \ | ||
| echo "protoc-gen-go-grpc version mismatch: expected $(PROTOC_GEN_GO_GRPC_VERSION), got $$installed"; \ | ||
| echo "install with: go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v$(PROTOC_GEN_GO_GRPC_VERSION)"; \ | ||
| exit 1; \ | ||
| fi | ||
|
|
||
| breaking: check-tools | ||
| @baseline=''; \ | ||
| if git -C .. rev-parse --verify main >/dev/null 2>&1; then \ | ||
| baseline='../.git#subdir=proto,branch=main'; \ | ||
| elif git -C .. rev-parse --verify origin/main >/dev/null 2>&1; then \ | ||
| baseline='../.git#subdir=proto,ref=refs/remotes/origin/main'; \ | ||
|
Comment on lines
+50
to
+53
There was a problem hiding this comment.
The baseline selection in Useful? React with 👍 / 👎. |
||
| else \ | ||
| echo "no breaking baseline found: neither 'main' nor 'origin/main' is reachable"; \ | ||
| echo "fetch main first (git fetch origin main) or override with BREAKING_AGAINST=..."; \ | ||
| exit 1; \ | ||
| fi; \ | ||
| if [ -n "$(BREAKING_AGAINST)" ]; then baseline='$(BREAKING_AGAINST)'; fi; \ | ||
|
Comment on lines
+55
to
+59
There was a problem hiding this comment.
Useful? React with 👍 / 👎. |
||
| $(BUF) breaking --against "$$baseline" | ||
|
|
||
| gen: check-tools breaking | ||
| $(BUF) generate | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| version: v2 | ||
| plugins: | ||
| - local: protoc-gen-go | ||
| out: . | ||
| opt: paths=source_relative | ||
| - local: protoc-gen-go-grpc | ||
| out: . | ||
| opt: paths=source_relative |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| version: v2 | ||
| modules: | ||
| - path: . | ||
| breaking: | ||
| use: | ||
| - WIRE |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
Fail on regenerated diffstep can miss missing generated artifacts becausegit diff --exit-code -- proto/only compares tracked changes (index/worktree) and returns success whenbuf generatecreates new untracked*.pb.gofiles. In that case CI can pass even though generation output is not fully committed (e.g., adding a new.protofile and forgetting togit addthe new generated file), so this gate does not reliably enforce the intended “committed output matches generated output” invariant.Useful? React with 👍 / 👎.