docs: validate recommended deployment snippets - #286
Draft
matthewygf wants to merge 2 commits into
Draft
matthewygf wants to merge 2 commits into
matthewygf wants to merge 2 commits into
Conversation
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.
Problem
PR #285 added two deterministic command failures to the recommended deployment guides:
set -euo pipefailand then expands$LD_PRELOADdirectly. On a clean host/container where the variable is unset, Bash exits withLD_PRELOAD: unbound variablebefore LMCache or vLLM starts.v0.4.4·(with a trailing Unicode middle dot) instead of the existing upstreamv0.4.4tag.The first failure is the same shell pattern addressed for the
dsv4_support_045documentation in #279, but #279 targets a different base branch and different file paths, so it cannot repair the newmainguide.Fix
v0.4.4.LD_PRELOADexpansion under nounset and reject non-ASCII/unsafe documented clone refs.Validation
LD_PRELOAD: unbound variable.LD_PRELOADboth unset and pre-populated.refs/tags/v0.4.4exists withgit ls-remote.python -m py_compile tests/test_documentation_snippets.pypasses.isort 6.0.1,ruff 0.11.7, andruff-formatchecks pass.git diff --check origin/mainpasses.Risk
Low. This changes two documentation commands and adds standard-library-only tests; no runtime code is modified.