Skip to content

docs(readme)+ci: WI-4 selective-install docs + flag e2e/validate smoke steps (#468) - #500

Merged
primetimetank21 merged 1 commit into
developfrom
feat/468-wi4-docs-ci
Jul 13, 2026
Merged

docs(readme)+ci: WI-4 selective-install docs + flag e2e/validate smoke steps (#468)#500
primetimetank21 merged 1 commit into
developfrom
feat/468-wi4-docs-ci

Conversation

@primetimetank21

Copy link
Copy Markdown
Owner

What

WI-4 (final slice of #468 ? flags-first customizable install):

README.md

  • New "Selective Install" section documenting all four flags (--list, --help, --only, --skip) with concrete examples for both the Linux/macOS/WSL (setup.sh) and Windows (setup.ps1) root entrypoints.
  • Documents verified behavior: --only does NOT auto-include prerequisites (--only=nvm installs only nvm; prereqs/uv are not pulled in automatically).
  • Documents --only/--skip mutual exclusion and --list precedence.

.github/workflows/e2e-install.yml

  • Added --list and --only smoke steps to e2e-linux, e2e-macos, and e2e-windows jobs.
  • Invoked via the root entrypoints (setup.sh --only=zsh on *nix; setup.ps1 -Only 'vim' on Windows), running after the full default install (idempotent, fast).

.github/workflows/validate.yml

  • Added flag-test steps to validate-linux (--list + --only=zsh), validate-macos (--list smoke), validate-powershell (-List), and validate-ps51 (-List under shell: powershell).

Why

WI-4 is the final slice of issue #468. The flags engine (WI-1/2/3) is already on develop; this
slice documents it for users and adds CI proof that the flags work end-to-end on all three
platforms. After this merges, #468 flags-first scope is complete (prompt/manifest deferred
to issue #495, Phase 2).

CI is the gate

No local install simulation needed for WI-4 -- the CI workflows themselves are the acceptance
gate. Default install regression (full e2e on all runners) is unchanged; flag smoke steps are
additive and run after the full setup (idempotent).

Checklist

  • README ASCII-clean (ascii-sweep dry-run: 0 replacements)
  • Workflow YAML: no backtick-n introduced; no smart quotes; pure ASCII PS steps
  • Flag invocations match the actual root wrapper signatures (verified against setup.sh / setup.ps1)
  • --only prereq caveat verified against flag engine source (build_final_toolset in scripts/linux/setup.sh; $FinalTools logic in scripts/windows/setup.ps1)
  • No regression: existing e2e and validate jobs unchanged; smoke steps are additive

…e steps (#468)

- README.md: Add "Selective Install" section documenting all four flags
  (--list/--help/--only/--skip) with concrete examples for both
  setup.sh (Linux/macOS/WSL) and setup.ps1 (Windows).
  Includes the verified caveat that --only does NOT auto-include
  prerequisites (e.g. --only=nvm installs only nvm, not prereqs/uv).
  Documents --only/--skip mutual exclusion and --list precedence.

- .github/workflows/e2e-install.yml: Add --list and --only smoke steps
  to e2e-linux, e2e-macos, and e2e-windows jobs via root entrypoints
  (setup.sh --only=zsh on *nix; setup.ps1 -Only 'vim' on Windows).
  Steps run after the full default install (idempotent, fast).

- .github/workflows/validate.yml: Add flag-test steps to validate-linux
  (--list + --only=zsh), validate-macos (--list smoke), validate-powershell
  (-List), and validate-ps51 (-List under shell: powershell).

WI-4 is the final slice of #468 (flags-first customizable install).
Prompt/manifest deferred to issue #495 (Phase 2, blocked-by #468).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@primetimetank21
primetimetank21 merged commit 012f0fb into develop Jul 13, 2026
10 checks passed
@primetimetank21
primetimetank21 deleted the feat/468-wi4-docs-ci branch July 13, 2026 00:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant