Skip to content

Conversation

@michalskrivanek
Copy link
Contributor

@michalskrivanek michalskrivanek commented Oct 3, 2025

for storing custom Driver descriptions to display in jmp shell CLI.

Summary by CodeRabbit

  • New Features
    • Report responses now include per-driver descriptive text for richer display and filtering.
    • Responses also include per-method help text (keyed by method name) to power CLI-friendly help and UI tooltips.
  • Compatibility
    • Backward-compatible addition; existing integrations continue to work while gaining access to the new descriptions and method help data.

@coderabbitai
Copy link

coderabbitai bot commented Oct 3, 2025

Walkthrough

Added two fields to DriverInstanceReport in proto/jumpstarter/v1/jumpstarter.proto: an optional string description = 4 and a map<string, string> methods_description = 5. No other messages, RPCs, or control flow were modified.

Changes

Cohort / File(s) Summary
Proto schema updates
proto/jumpstarter/v1/jumpstarter.proto
Added optional string description = 4 and map<string, string> methods_description = 5 to message DriverInstanceReport. Comments indicate description is CLI-friendly driver text and methods_description holds method help text. No other schema or RPC changes.

Sequence Diagram(s)

(No sequence diagram provided — change is schema-only and does not alter control flow.)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I twitch my nose at fields anew,
A string and map hop into view.
Drivers whisper help in tidy rows,
Methods labeled where the README grows.
Carrots and bytes — a small delight, good night.

Pre-merge checks and finishing touches

✅ 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 concisely describes the primary change—adding a descriptions field to the GetReport response—and uses specific terminology without extraneous detail, making it immediately clear to reviewers what the pull request achieves. It accurately reflects the intent to extend the CLI’s report output. The phrasing is succinct and free of noise.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 47a6671 and b49c229.

📒 Files selected for processing (1)
  • proto/jumpstarter/v1/jumpstarter.proto (1 hunks)
🔇 Additional comments (1)
proto/jumpstarter/v1/jumpstarter.proto (1)

70-71: LGTM: new CLI-friendly metadata fields look great.

Field numbering and types are consistent and backward-compatible, so we’re good here.


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.

❤️ Share

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

michalskrivanek added a commit to michalskrivanek/jumpstarter that referenced this pull request Oct 3, 2025
store custom Driver and its methods description in each DriverInstanceReport to display in jmp shell CLI.
@mangelajo mangelajo merged commit 4f8035c into jumpstarter-dev:main Oct 6, 2025
2 checks passed
michalskrivanek added a commit to michalskrivanek/jumpstarter that referenced this pull request Oct 7, 2025
jumpstarter-backport-bot bot pushed a commit to jumpstarter-dev/jumpstarter that referenced this pull request Oct 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants