Skip to content

docs(README): document --force flag + versioned-block upgrade + CI#7

Merged
ashbrener merged 1 commit into
mainfrom
docs/readme-post-merge-refresh
Apr 28, 2026
Merged

docs(README): document --force flag + versioned-block upgrade + CI#7
ashbrener merged 1 commit into
mainfrom
docs/readme-post-merge-refresh

Conversation

@ashbrener

Copy link
Copy Markdown
Owner

Summary

  • Document the versioned-block upgrade behavior introduced in PR fix(pre-push): env-overflow on big pushes #4# wingman-hook-version: N stamp, automatic in-place upgrade when re-running the installer, and the --force / --reinstall flag for unconditional block replacement.
  • Mention the --help flag and surface bash scripts/install.sh as a first-class invocation alongside npx skills add and /review-setup.
  • New ## CI section describing .github/workflows/wingman-ci.yml (PR ci: add lint + syntax + install-smoke workflow #5) — lint (shellcheck), syntax (bash -n + embedded Python py_compile), and install-smoke (fresh / v1 -> v2 upgrade / --force scenarios) — with a note that the installer is cross-platform (macOS + Linux) thanks to PR fix(install): cross-platform mktemp + 3 shellcheck warnings #6's mktemp fix.

Test plan

  • No code changes; README only
  • CI workflow runs (lint + syntax + install-smoke); should be green

Catch up the README with PR #4 (versioned-block installer + --force
reinstall flag) and PR #5 (CI workflow). Documents:
- The hook-version marker pattern (# wingman-hook-version: N)
- --force / --reinstall flag for unconditional block replacement
- --help flag for installer usage
- .github/workflows/wingman-ci.yml runs lint + syntax + install-smoke
  on every PR (validates macOS + Linux compatibility)

No code changes; pure docs catch-up.
@ashbrener ashbrener marked this pull request as ready for review April 28, 2026 20:44
@ashbrener ashbrener merged commit 2fe82f4 into main Apr 28, 2026
3 checks passed
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