fix(stack): drop the removed --proxy flags from the shipped README - #847
Conversation
The `stash init` flag table in `packages/stack/README.md` still listed `--proxy` / `--no-proxy` as supported. Those flags were removed with the EQL v2 CipherStash Proxy lifecycle: they are absent from the command registry, `stash init` rejects them with an actionable message, and both `packages/cli/README.md` and `skills/stash-cli/SKILL.md` were already updated. This README ships in the `@cipherstash/stack` tarball, so the stale row was wrong guidance in customer repos. The existing residue guard (`scripts/__tests__/no-removed-eql-version-flag.test.mjs`) scans `packages/*/README.md` but only inside fenced shell blocks, so a markdown table row was structurally invisible to it — which is why this line survived. Closes #816
🦋 Changeset detectedLatest commit: ff70532 The changes in this PR will be included in the next version bump. This PR includes changesets to release 11 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Warning Review limit reached
Next review available in: 21 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Approved. I'll also close #790. |
Closes #816 — the last outstanding item on criterion 8 ("Reconcile pending changesets, skills, READMEs, and the #772/#778 tracking text after the removal work lands").
What was wrong
packages/stack/README.mdstill listed--proxy/--no-proxyin thestash initflag table:Those flags were removed with the EQL v2 CipherStash Proxy lifecycle in #825. Everything else was already correct:
packages/cli/src/cli/registry.ts(initdeclares exactly--supabase,--drizzle,--prisma-next,--region);packages/cli/src/commands/init/index.ts:74-79rejects them with an actionable message;packages/cli/src/__tests__/v2-retirement.test.ts:27-32andpackages/cli/tests/e2e/v2-retirement.e2e.test.ts:29-32;packages/cli/README.mdandskills/stash-cli/SKILL.mdare clean.packages/stack/package.jsonshipsREADME.mdin the tarball, so this row was wrong guidance reaching customer repos.Why nothing caught it
There is no doc-level guard for retired flags at all. Two things look like they should have caught this and neither is in scope:
packages/cli/src/__tests__/v2-retirement.test.ts:27-32asserts--proxy/--no-proxyare absent from the registry — that is, from code. It never reads documentation.scripts/__tests__/no-removed-eql-version-flag.test.mjsdoes scanpackages/*/README.mdandskills/*/SKILL.md, but it is single-purpose: its matcher only ever looks forstash eql install … --eql-versioninside fenced shell blocks. It would not have caught--proxyin a fenced block either. The markdown-table format is incidental.So this class of drift can recur anywhere in the shipped docs with CI green. The follow-up worth building is a guard that takes the set of retired flag names and asserts their absence across
packages/*/README.md+skills/*/SKILL.md, with the exemptions the current tree legitimately needs: the product CipherStash Proxy inskills/stash-postgresandskills/stash-auth, the removal-error text atpackages/cli/src/bin/main.ts:305, and published CHANGELOGs. Left out of this PR to keep it to the one-line fix.Not #790
#790 also removes this row, but it is
CONFLICTING, 177 commits behind / 58 ahead ofmain, 291 files, +10,971/−30,202, and it touchespackages/protect/README.mdandpackages/schema/README.md— pre-rename paths that would resurrect deleted packages. Do not close #816 by merging it.Verification
registry.ts:119-138one-for-one — all fourinitflags, no extras — on this branch and onorigin/main.grep -i proxy packages/stack/README.mdreturns nothing, so the deleted row was not the anchor for any surrounding prose.git grep -E '\-\-proxy|--no-proxy'over shipped READMEs andskills/**: no hits. Remaining repo hits are intentional — the product CipherStash Proxy inskills/stash-postgresandskills/stash-auth(explicitly framed as a different path), the removal-error text inpackages/cli/src/bin/main.ts:305, v2eql_v2_configurationinpackages/cli/src/commands/db/status.ts, internaldocs/plans/, the absence assertions above, and published CHANGELOGs.vitest run --config scripts/vitest.config.mjs: 14 files / 178 tests passed. Green either way on this change, per the section above.code:checkis a no-op on both files.@cipherstash/prisma-next→@cipherstash/stack-prismarename, merged asd2772b0cafter this branch was cut): it leavespackages/stack/README.mduntouched and the--prisma-nextflag name intact, so the row above the deletion is still accurate.Changeset
@cipherstash/stack: patch. Precedent for a README-only entry on this package is.changeset/remove-eql-v2-drizzle-root.md:25.@cipherstash/stackalready carries aminorthis release train via.changeset/adapter-release-readiness.md; changesets takes the max, so this adds the changelog line without disturbing the bump.Also verified while confirming scope
The other half of the #816 status comment —
db pushresidue inpackages/wizard/README.md— was already fixed by0fc041ac(#838, merged2d7ef563). That comment was written ~1h before #838 landed. No wizard change is needed here.