feat(ci): introduce check-proto.yaml workflow
#287
Conversation
This workflow runs the `protocgen.sh` script via the Makefile and fails if any files have changed
The `repeated string` type is never nullable
MaxMustermann2
requested review from
rlan35,
bwhour,
adu-web3,
cloud8little,
trestinlsd,
mikebraver,
TimmyExogenous and
leonz789
WalkthroughThis pull request introduces a new GitHub Actions workflow to automate the checking of protocol buffer (proto) file generation. The workflow is designed to run on pull requests and pushes to key branches, executing a Changes
Sequence DiagramsequenceDiagram
participant PR as Pull Request
participant GHA as GitHub Actions
participant Repo as Repository
PR->>GHA: Trigger workflow
GHA->>Repo: Checkout code
GHA->>Repo: Run make proto-gen
GHA->>Repo: Check for changes
alt Changes detected
GHA-->>PR: Workflow fails
else No changes
GHA-->>PR: Workflow passes
end
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
.github/workflows/check-proto.yaml (2)
14-17: Consider reducing the timeout duration.10 minutes seems excessive for proto generation. Consider reducing to 5 minutes as proto generation typically completes within a minute.
- timeout-minutes: 10 + timeout-minutes: 5
27-33: Enhance error reporting and CI performance.Consider these improvements:
- Make the error message more actionable
- Add caching for proto tools
- Format the diff output for better readability
+ - name: Cache Proto Tools + uses: actions/cache@v3 + with: + path: | + /usr/local/bin/protoc + /usr/local/bin/protoc-gen-go + key: ${{ runner.os }}-proto-tools-${{ hashFiles('Makefile') }} - name: Check if any files have changed post regeneration run: | if ! git diff --exit-code > /dev/null 2>&1; then - echo "Changes detected after running 'make proto-gen'." + echo "Error: Proto files are out of sync with their definitions." + echo "Please run 'make proto-gen' locally and commit the changes." + echo "Changes detected:" - git diff + git diff --color=always | sed 's/^/ /' exit 1 fi
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
x/delegation/types/genesis.pb.gois excluded by!**/*.pb.gox/dogfood/types/query.pb.gois excluded by!**/*.pb.gox/dogfood/types/query.pb.gw.gois excluded by!**/*.pb.gw.go
📒 Files selected for processing (2)
.github/workflows/check-proto.yaml(1 hunks)proto/exocore/delegation/v1/genesis.proto(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: test-unit-cover
- GitHub Check: build
- GitHub Check: run-lint
- GitHub Check: goreleaser
- GitHub Check: build
- GitHub Check: Analyze (go)
🔇 Additional comments (2)
.github/workflows/check-proto.yaml (1)
1-13: LGTM! Well-configured workflow triggers and permissions.The workflow is properly configured to run on relevant events (PRs and pushes to main branches) with appropriate minimal permissions.
proto/exocore/delegation/v1/genesis.proto (1)
45-45: Maintain consistency with nullable options.The removal of
[(gogoproto.nullable) = false]from thestakersfield creates inconsistency with other repeated fields in this file. While this won't affect Go code generation for repeated fields, consider:
- Other similar fields like
associations,delegation_statesmaintain the nullable option- This might impact other language generators
Let's check for consistency across proto files:
- repeated string stakers = 2; + repeated string stakers = 2 [(gogoproto.nullable) = false];
This workflow runs the
protocgen.shscript via the Makefile and failsif any files have changed
Summary by CodeRabbit
stakersfield inStakersByOperatormessage