Conversation
WalkthroughAdds a new GitHub Actions workflow to run Buf on protobuf sources and updates the Buf module metadata to lowercase name and additional external proto dependencies. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Dev as Developer (push/tag/release/PR)
participant GH as GitHub Actions
participant Runner as Runner (ubuntu-latest)
participant BufAction as buf-action@v1
participant Registry as buf.build
Dev->>GH: Push/Tag(v*)/Release/PR touching proto/**
GH->>Runner: Start buf-build job (timeout 5m)
Runner->>Runner: actions/checkout@v5
Runner->>BufAction: Run with inputs (proto, BUF_TOKEN, format/lint/breaking=false, push=true)
BufAction->>Registry: Push proto module
Registry-->>BufAction: Acknowledge
BufAction-->>Runner: Complete
Runner-->>GH: Job result
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro Cache: Disabled due to data retention organization setting Knowledge base: Disabled due to 📒 Files selected for processing (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (5)
.github/workflows/proto.yml (5)
2-4: Comment contradicts actual triggers and disabled checksThe header says this runs fmt/lint/breaking and “only when a .proto file has been changed”, but the workflow disables those checks and also triggers on tags and releases (which aren’t path-filtered). Update the comment or adjust triggers accordingly.
13-17: Release trigger likely does nothing with current configWith format/lint/breaking disabled and push intended for Git pushes only, the release event won’t meaningfully execute buf-action. Remove it or add specific steps for releases. (github.com)
24-26: Timeout may be too tightPushing/BSR ops can exceed 5 minutes on cold runners or larger modules. Consider 10–15 minutes.
- timeout-minutes: 5 + timeout-minutes: 10
28-35: buf-action inputs: good start; harden by disabling PR comments and preventing accidental BSR repo creation
- token/input keys are correct for buf-action@v1.
- Add pr_comment: false to avoid needing PR write perms.
- Consider push_disable_create: true to avoid creating BSR repos implicitly. (github.com)
Apply this diff:
- uses: bufbuild/buf-action@v1 with: input: proto token: ${{ secrets.BUF_TOKEN }} format: false lint: false breaking: false push: true + pr_comment: false + push_disable_create: true
35-35: Add newline at EOFYAMLlint flags the missing trailing newline.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting
📒 Files selected for processing (1)
.github/workflows/proto.yml(1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.37.1)
.github/workflows/proto.yml
[error] 35-35: no new line character at the end of file
(new-line-at-end-of-file)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: spellcheck
- GitHub Check: Analyze (go)
🔇 Additional comments (2)
.github/workflows/proto.yml (2)
27-27: actions/checkout@v5 is validv5 exists and is the current major. Keep it. (github.com)
28-32: Secret setup checkEnsure repository/org secret BUF_TOKEN is present and scoped to this repo/environment; without it, pushes to BSR will fail.
…st start with a lowercase letter
1 participant
Description
to publish proto definitions on BSR.
fyi disabled many features like fmt, lint and check-breaking as it is initial commit for the action.
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
Summary by CodeRabbit