docs(grpc-proto): add remote dev workflow for testing proto changes - #492
Conversation
Summary of ChangesHello @CatherineSue, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the developer experience by providing a much-needed documented workflow for testing Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
No actionable comments were generated in the recent review. 🎉 📝 WalkthroughWalkthroughThis PR adds a "Testing proto changes on a remote GPU machine" section to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Code Review
The pull request introduces a new section to the grpc_client/python/README.md file, detailing a workflow for testing .proto file changes on a remote GPU machine. This is a helpful addition for developers, providing clear instructions for building a wheel locally, copying it to a remote environment, and installing it. The changes are well-documented and address a practical problem. No critical issues were found.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@grpc_client/python/README.md`:
- Around line 51-62: Add a pre-step before the "pip wheel" step to copy the
actual .proto files into the smg_grpc_proto/proto directory (resolving the
symlink) so the wheel packages real files instead of a symlink; mirror the CI
workaround by copying the proto sources into the package tree prior to running
pip wheel (update the README instructions around the pip wheel command and
reference smg_grpc_proto/proto and the pip wheel step so maintainers know where
to place the copy).
Signed-off-by: Chang Su <chang.s.su@oracle.com>
Signed-off-by: Chang Su <chang.s.su@oracle.com>
d225d64 to
fcee8cb
Compare
Description
Problem
When iterating on
.protofile changes, there's no documented workflow for testing updated Python stubs on a remote GPU machine (e.g. where vLLM runs). Developers have to figure out the wheel-build-and-copy process each time.Solution
Add a short section to the grpc_client Python README documenting the three-step workflow: build wheel locally, scp to remote, force-reinstall.
Changes
grpc_client/python/README.mdTest Plan
Documentation-only change. Verified the wheel build/install steps work on a remote vLLM environment.
Checklist
cargo +nightly fmtpassescargo clippy --all-targets --all-features -- -D warningspassesSummary by CodeRabbit