This repository was archived by the owner on Jan 23, 2026. It is now read-only.
[Backport release-0.7] Custom driver descriptions#695
Merged
mangelajo merged 6 commits intorelease-0.7from Oct 8, 2025
Merged
Conversation
introducing new format in addition to the simple
methods:
method: "command"
you can now specify per-method customization with:
methods:
method:
description: "This shows up in the CLI"
method: "echo Hello"
timeout: 5
(cherry picked from commit e94dc35)
from jumpstarter-dev/jumpstarter-protocol#28 (cherry picked from commit c4271f3)
this allows override of the default strings to show up in the jmp shell CLI.
the Driver descriptions can be customized with:
exporter:
driver_x:
type: x
description: "this driver does x"
methods_description:
"method1": "this method does y"
"method2": "this method does z"
config:
...
- Add driver_click_group decorator in client/decorators.py for CLI generation. Annotated method will be used as CLI group description(driver).
- Add driver_click_command decorator to use when there is no group (a single command driver)
- Add description and methods_description field to DriverClient, retrieved via GetReport call from server.
- Add description and methods_description field to Driver base class, only when customized (i.e. defaults are not transmitted).
The infrastructure is using a single DriverInstanceReport message to save on RPC calls.
(cherry picked from commit 46f94b1)
… decorator Replace @click.group decorators with @driver_click_group and @click.command with @driver_click_command in all drivers, and use it to provide server-side driver description. The CLI client will retrieve customized driver's description via GetReport() from the exporter. When there's no customization it falls back to locally provided default in docstring or help=. (cherry picked from commit bedc72f)
eliminate the extra RPC introduced in https://github.com/jumpstarter-dev/jumpstarter/pull/685 (cherry picked from commit c1ec0c8)
(cherry picked from commit 354d6d8)
Contributor
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the Note Free review on us!CodeRabbit is offering free reviews until Wed Oct 08 2025 to showcase some of the refinements we've made. Comment |
mangelajo
approved these changes
Oct 8, 2025
Member
mangelajo
left a comment
mangelajo
left a comment
There was a problem hiding this comment.
Backwards compatibility verified.
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Bot-based backport to
release-0.7, triggered by a label in #690.