Skip to content

docs(grpc-proto): add remote dev workflow for testing proto changes - #492

Merged
slin1237 merged 2 commits into
mainfrom
chang/mm-4
Feb 21, 2026
Merged

slin1237 merged 2 commits into
mainfrom
chang/mm-4

Conversation

@CatherineSue

@CatherineSue CatherineSue commented Feb 21, 2026 •

Copy link
Copy Markdown
Member

Description

Problem

When iterating on .proto file 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

  • Added "Testing proto changes on a remote GPU machine" section to grpc_client/python/README.md

Test Plan

Documentation-only change. Verified the wheel build/install steps work on a remote vLLM environment.

Checklist
  • cargo +nightly fmt passes
  • cargo clippy --all-targets --all-features -- -D warnings passes
  • (Optional) Documentation updated

Summary by CodeRabbit

  • Documentation
    • Updated README with step-by-step guidance for testing protocol buffer changes on remote GPU machines, including building a wheel from local changes, transferring and reinstalling it on the remote environment, and notes that no import changes are required on the remote side.

@github-actions github-actions Bot added documentation Improvements or additions to documentation grpc gRPC client and router changes labels Feb 21, 2026
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @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 .proto file modifications within remote GPU environments, such as vLLM. It addresses the previous lack of clear guidance by detailing the steps required to build updated Python stubs locally and deploy them to a remote system, thereby streamlining the iteration process for developers.

Highlights

  • Remote Development Workflow: Added a new section to grpc_client/python/README.md that outlines a three-step process for testing .proto file changes on remote GPU machines. This workflow includes building a Python wheel, securely copying it to the remote, and force-reinstalling it.
Changelog
  • grpc_client/python/README.md
    • Added a new section titled "Testing proto changes on a remote GPU machine" which includes instructions for building a Python wheel, copying it to a remote server, and installing it.
Activity
  • The author verified the documented wheel build and install steps in a remote vLLM environment.
  • The changes are documentation-only.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

@coderabbitai

coderabbitai Bot commented Feb 21, 2026 •

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉


📝 Walkthrough

Walkthrough

This PR adds a "Testing proto changes on a remote GPU machine" section to grpc_client/python/README.md, describing how to build a wheel from local .proto changes, transfer it to a remote machine, and reinstall it there without import changes.

Changes

Cohort / File(s) Summary
Documentation
grpc_client/python/README.md
Adds a new section under Development/README describing building a wheel from local .proto changes, transferring the wheel to a remote GPU machine, and reinstalling it remotely for testing.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • slin1237

Poem

🐇 I nudge the proto, spin a wheel so bright,
Pack it up, send it off through night,
On distant GPUs my changes play,
Silent tests hum far away,
Hooray — the rabbit hops in light!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: adding documentation for a remote development workflow for testing proto changes. It is concise, specific, and directly reflects the core purpose of the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chang/mm-4

Comment @coderabbitai help to get the list of available commands and usage tips.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Comment thread grpc_client/python/README.md
Signed-off-by: Chang Su <chang.s.su@oracle.com>
Signed-off-by: Chang Su <chang.s.su@oracle.com>
@slin1237
slin1237 merged commit 19377fa into main Feb 21, 2026
22 checks passed
@slin1237
slin1237 deleted the chang/mm-4 branch February 21, 2026 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation grpc gRPC client and router changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants