Skip to content

docs(cli): align v5 help with lockfile-first patching - #1297

Merged
Mikola Lysenko (mikolalysenko) merged 4 commits into
mainfrom
docs/1289-lockfile-first-help
Oct 9, 2026
Merged

Mikola Lysenko (mikolalysenko) merged 4 commits into
mainfrom
docs/1289-lockfile-first-help

Conversation

@mikolalysenko

@mikolalysenko Mikola Lysenko (mikolalysenko) commented Oct 9, 2026 •

Copy link
Copy Markdown
Collaborator

Make root and scan help describe discovery from project dependency files, including fresh checkouts, hosted writes by default, and --dry-run previews. 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: build is rejected through both CLI and environment configuration, auto aliases service, 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 -- --check and git diff --check passed.
  • Inspected rendered root, scan, and repair help with both -h and --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: scan is described as discovering patches from dependency files (including fresh checkouts), with explicit caveats for agent mode and ecosystems like sbt/scala-cli.

repair is reframed in root help, README, usage, and migration docs as restoring both agent and vendored artifacts, including that a lost .socket/vendor/state.json must come from version control—not rebuilt from lockfiles.

Documentation now spells out service-only vendoring: --vendor-source build / SOCKET_VENDOR_SOURCE=build are usage errors, auto aliases service with 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

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.
@mikolalysenko Mikola Lysenko (mikolalysenko) added the Ready for review Agent-verified: mergeable, CI green, Bugbot clean — awaiting human review label Oct 9, 2026
@mikolalysenko

Copy link
Copy Markdown
Collaborator Author

Ready for review (burn-down agent).


Generated by Claude Code

@mikolalysenko
Mikola Lysenko (mikolalysenko) added this pull request to the merge queue Oct 9, 2026
@mikolalysenko
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
@mikolalysenko
Mikola Lysenko (mikolalysenko) added this pull request to the merge queue Oct 9, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Oct 9, 2026
@mikolalysenko
Mikola Lysenko (mikolalysenko) added this pull request to the merge queue Oct 9, 2026
Merged via the queue into main with commit e1acd60 Oct 9, 2026
53 checks passed
@mikolalysenko
Mikola Lysenko (mikolalysenko) deleted the docs/1289-lockfile-first-help branch October 9, 2026 23:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Ready for review Agent-verified: mergeable, CI green, Bugbot clean — awaiting human review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

v5: align help and migration docs with lockfile-first scans and service-only vendoring

2 participants