Repository navigation
docs(cli): spice version always names the runtime path, managed install included - #2190
Merged
Merged
Conversation
…ll included The version page said the path/source line appears only 'for a runtime outside the managed install'. version.rs prints it whenever a runtime resolves, with no test on the source, so a reader on an ordinary managed install is told they will not see a line they do see. The conditional does exist, but it belongs to 'spice run': report_resolved_runtime logs at info for a non-managed runtime and at debug for the managed one. Splits the two commands' behavior apart, lists the four source strings, and says when the line is genuinely absent.
Contributor
✅ Pull with Spice PassedPassing checks:
|
Contributor
🔍 Pull with Spice FailedPassing checks:
Failed checks:
Please address these issues and update your pull request. |
Contributor
|
🚀 deployed to https://e3aaf542.spiceai-org-website.pages.dev |
lukekim
approved these changes
Sep 10, 2026
4 tasks done
lukekim
pushed a commit
that referenced
this pull request
Sep 12, 2026
The version-2.3.x snapshot was cut hours before #2190, so it still ties the Runtime path line to a runtime outside the managed install. At v2.3.0 spice version prints it whenever a runtime resolves, with no test on the source; the conditional is real but belongs to spice run, where it is a log level, not presence.
This branch was successfully deployed
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
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
#2186 added runtime-path reporting to the
spice versionandspice runpages, both gated on the same condition:spice versiondoes not test the source. It prints the line whenever a runtime resolves:So a reader on the ordinary
spice installlayout — the commonest one — is told they will not see a line they do see, and the "sample output" blocks above it show a two-line output that no longer matches.The conditional is real, but it belongs to
spice run, and it is a log level, not presence:is_expected_default()is true only forManagedInstall, and its doc comment is explicit that this is "what keepsspice runfrom announcing its runtime". The two commands were collapsed into one sentence that is right for neither.What changed
version.md— the line is described as unconditional, with the managed install as the shown example; enumerates the fourdescribe()strings verbatim (pinned by SPICED_PATH,beside the spice CLI,installed by spice install,installed by spice install, by the sudo invoker); names the two cases where it is absent (no runtime resolves, or--cli-only); and records the located-but-unprobeable case, whoseRuntime version:text is quoted from source. Notes thatruntime_sourcein JSON is the enum, not the prose — the code comments that this deliberately, so docs describing it as the same string would be wrong.run.md— replaces the shared sentence withspice run's own behavior, quoting the log message and saying which level each case gets, then states thatspice versionreports the same values unconditionally.Every quoted string is a static template with no substituted fields except the path and source, which the text identifies as such.
Source refs (spiceai/spiceai @
2f10331)bin/spice/src/commands/version.rs#L198-L235— unconditional table output;runtime_path/runtime_sourcein JSONbin/spice/src/commands/version.rs#L250— theunavailable — …did not report a versionstringbin/spice/src/runtime_launcher.rs#L118-L133—report_resolved_runtime, the info/debug splitbin/spice/src/context.rs#L994-L1012—SpicedSource::describe()andis_expected_default()The four-rung selection order #2186 documented is accurate as written —
context.rs#L518-L527lists the same four, andPATHreally is excluded by design.Scope
vNext only — neither claim exists in any versioned snapshot (
grep -rn "Runtime path" website/versioned_docs/is empty), and the reporting itself is newer than v2.2.1.Test plan
cd website && npm run buildpasses (./run#runtime-selectionand./installboth resolve)