-
Notifications
You must be signed in to change notification settings - Fork 590
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: check breaking change in protobuf (#7609)
This PR adds the workflow of detecting breaking changes in protobuf to the CI workflow. Here is an example of error reporting: - c1dd48e We've set the rule category to `WIRE_JSON` which is explained [here](https://docs.buf.build/breaking/rules). Actually `WIRE` is enough for our major usages, while `WIRE_JSON` ensures that the name of the fields is not modified, which brings less confusion to the codebase and also makes the JSON-based dashboard easier to maintain (e.g., avoid #7262 from happening). We may not need to add this workflow to GitHub's branch protection rule until the next release. Approved-By: TennyZhuang
- Loading branch information
Showing
3 changed files
with
23 additions
and
1 deletion.
There are no files selected for viewing
This file contains 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
This file contains 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,19 @@ | ||
name: Protobuf Breaking Check | ||
|
||
on: | ||
pull_request: | ||
branches: [main] | ||
paths: [proto/**] | ||
|
||
jobs: | ||
buf-breaking-check: | ||
runs-on: ubuntu-latest | ||
name: Check breaking changes in Protobuf files | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: bufbuild/buf-setup-action@v1 | ||
# Run breaking change detection against the `main` branch | ||
- uses: bufbuild/buf-breaking-action@v1 | ||
with: | ||
input: 'proto' | ||
against: 'https://github.com/risingwavelabs/risingwave.git#branch=main,subdir=proto' |
This file contains 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,4 +1,7 @@ | ||
version: v1 | ||
breaking: | ||
use: | ||
- WIRE_JSON # https://docs.buf.build/breaking/rules | ||
lint: | ||
use: | ||
- DEFAULT | ||
|