Open
Conversation
WalkthroughThis PR updates the project to support Protobuf 5.27.2 (from 3.21.12/4.21.12), migrates proto definitions from proto3 syntax to edition 2023 with implicit field presence annotations, and regenerates C++, C#, and Python compiled code. The fleet protocol version is bumped to 2.1.0. Changes
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes 🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 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: 1
🤖 Fix all issues with AI agents
In `@protobuf/README.md`:
- Around line 21-29: Change the incorrect heading level and remove the stray
orphan heading: rename the "#### Requirements" heading to "### Requirements" so
it follows the top-level "##" section, remove the extraneous "##" line after the
code block, and tidy surrounding blank lines to keep consistent Markdown
hierarchy in the README (look for the "#### Requirements" and the orphaned "##"
tokens to locate the edits).
🧹 Nitpick comments (3)
.gitignore (1)
4-5: Prefer directory-specific ignore for IDE cacheIf the intent is to ignore the
.ideadirectory only, consider.idea/for clarity and to avoid accidental matches.protobuf/README.md (1)
33-35: Consider adding language specifiers to code blocks.Adding
bashorshelllanguage identifiers to the fenced code blocks would improve syntax highlighting for readers.📝 Example fix
-``` +```bash find protobuf/definition -name "*.proto" -exec protoc -I=./protobuf/definition --cpp_out=./protobuf/compiled/cpp --csharp_out=./protobuf/compiled/cs --python_out=./protobuf/compiled/python --go_out=./protobuf/compiled/go/ --go_opt=paths=source_relative {} +Apply the same pattern to the other code blocks at lines 43, 49, 55, and 61. </details> </blockquote></details> <details> <summary>examples/protobuf_parsing_example/lib/protobuf/ProtobufModule.pb.h (1)</summary><blockquote> `2-4`: **Add CI check to verify protobuf generated code stays in sync with source `.proto` file.** Generated protobuf files (ProtobufModule.pb.h/.pb.cc) are checked into the repository but there is no automatic regeneration during build. Consider adding a CI step that regenerates the files from ExampleModule.proto and fails if any differences are detected. Additionally, document the regeneration command in the example's README (similar to the instructions in `protobuf/README.md` for C++, targeted at `examples/protobuf_parsing_example/lib/protobuf/`). </blockquote></details> </blockquote></details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Comment on lines
+21
to
+29
| #### Requirements | ||
|
|
||
| - desired version of `protoc` installed ([prebuilt binaries](https://github.com/protocolbuffers/protobuf/releases)) | ||
| - `protoc-gen-go` needs to be installed to generate go files (set env value GOBIN to the path where protoc is installed first) | ||
| ```bash | ||
| go install google.golang.org/protobuf/cmd/protoc-gen-go@latest | ||
| ``` | ||
|
|
||
| ## |
There was a problem hiding this comment.
Fix heading hierarchy and remove empty heading.
The #### Requirements heading skips heading levels (should be ### after ##), and line 29 has an orphaned ## that appears unintentional.
📝 Suggested fix
-#### Requirements
+### Requirements
- desired version of `protoc` installed ([prebuilt binaries](https://github.com/protocolbuffers/protobuf/releases))
- `protoc-gen-go` needs to be installed to generate go files (set env value GOBIN to the path where protoc is installed first)
```bash
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest-##
Compile to all languages:
</details>
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.18.1)</summary>
21-21: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
In @protobuf/README.md around lines 21 - 29, Change the incorrect heading level
and remove the stray orphan heading: rename the "#### Requirements" heading to
"### Requirements" so it follows the top-level "##" section, remove the
extraneous "##" line after the code block, and tidy surrounding blank lines to
keep consistent Markdown hierarchy in the README (look for the "####
Requirements" and the orphaned "##" tokens to locate the edits).
</details>
<!-- fingerprinting:phantom:medusa:ocelot -->
<!-- This is an auto-generated comment by CodeRabbit -->
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary by CodeRabbit
New Features
Chores
✏️ Tip: You can customize this high-level summary in your review settings.