Repository navigation
docs(cli): align v5 help with lockfile-first patching - #1297
Merged
Mikola Lysenko (mikolalysenko) merged 4 commits intoOct 9, 2026
Merged
Conversation
Explain hosted scan writes, dry-run previews, and fresh-checkout discovery with mode and ecosystem prerequisites. Describe repair for both agent and vendored artifacts and retain the lost-ledger recovery limitation. Document service-only vendoring, rejected build configuration, auto alias semantics, and offline artifact reuse in the v5 migration guide. Update the existing help expectations without changing command behavior.
Tanmay Singla (Tanmay182003)
approved these changes
Oct 9, 2026
Collaborator
Author
|
Ready for review (burn-down agent).
Generated by Claude Code |
Mikola Lysenko (mikolalysenko)
enabled auto-merge
October 9, 2026 18:22
Mikola Lysenko (mikolalysenko)
disabled auto-merge
October 9, 2026 19:55
Mikola Lysenko (mikolalysenko)
enabled auto-merge
October 9, 2026 21:31
Mikola Lysenko (mikolalysenko)
removed this pull request from the merge queue due to a manual request
Oct 9, 2026
# Conflicts: # docs/migrating-to-v5.md # docs/usage.md
Mikola Lysenko (mikolalysenko)
enabled auto-merge
October 9, 2026 22:07
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
Oct 9, 2026
Mikola Lysenko (mikolalysenko)
deleted the
docs/1289-lockfile-first-help
branch
October 9, 2026 23:16
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.
Make root and scan help describe discovery from project dependency files, including fresh checkouts, hosted writes by default, and
--dry-runpreviews. Keep installation and resolution prerequisites explicit for agent mode and affected ecosystems. Show repair as an agent and vendored artifact command, including the requirement to restore a lost vendor ledger from version control.Align the README and usage guide, and document the v5 service-only vendoring break:
buildis rejected through both CLI and environment configuration,autoaliasesservice, unavailable artifacts never fall back to local builds, and offline reuse of healthy committed artifacts differs from fetching new ones. No command names, defaults, or behavior change.Closes #1289.
Validation:
cargo test --locked -p socket-patch-cli --test help_text_hygiene --test cli_parse_scan --test cli_parse_repair --test cli_parse_vendor— 109 tests passed.cargo fmt -p socket-patch-cli -- --checkandgit diff --checkpassed.-hand--help.The full workspace formatting check reports an existing formatting difference in
crates/socket-patch-core/src/patch/redirect/upstream/mod.rs:917; that file is identical to the base and unchanged by this PR.Note
Low Risk
Documentation and help-text only; behavior and CLI defaults are unchanged per the PR description.
Overview
Updates user-facing docs and CLI help so v5 reads as lockfile-first hosted patching:
scanis described as discovering patches from dependency files (including fresh checkouts), with explicit caveats for agent mode and ecosystems like sbt/scala-cli.repairis reframed in root help, README, usage, and migration docs as restoring both agent and vendored artifacts, including that a lost.socket/vendor/state.jsonmust come from version control—not rebuilt from lockfiles.Documentation now spells out service-only vendoring:
--vendor-source build/SOCKET_VENDOR_SOURCE=buildare usage errors,autoaliasesservicewith no local build fallback, while committed healthy artifacts can still install offline.Help hygiene tests are updated to match the new strings; no runtime behavior or CLI defaults change in this PR.
Reviewed by Cursor Bugbot for commit be0f04d. Configure here.
Generated by Claude Code