Skip to content

fix(stack): drop the removed --proxy flags from the shipped README - #847

Merged
coderdan merged 1 commit into
mainfrom
fix/issue-816-proxy-readme
Jul 30, 2026
Merged

fix(stack): drop the removed --proxy flags from the shipped README#847
coderdan merged 1 commit into
mainfrom
fix/issue-816-proxy-readme

Conversation

@tobyhede

@tobyhede tobyhede commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

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.md still listed --proxy / --no-proxy in the stash init flag table:

| `--proxy` / `--no-proxy` | Opt in/out of the CipherStash Proxy path |

Those flags were removed with the EQL v2 CipherStash Proxy lifecycle in #825. Everything else was already correct:

  • absent from packages/cli/src/cli/registry.ts (init declares exactly --supabase, --drizzle, --prisma-next, --region);
  • packages/cli/src/commands/init/index.ts:74-79 rejects them with an actionable message;
  • asserted absent by packages/cli/src/__tests__/v2-retirement.test.ts:27-32 and packages/cli/tests/e2e/v2-retirement.e2e.test.ts:29-32;
  • packages/cli/README.md and skills/stash-cli/SKILL.md are clean.

packages/stack/package.json ships README.md in 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-32 asserts --proxy / --no-proxy are absent from the registry — that is, from code. It never reads documentation.
  • scripts/__tests__/no-removed-eql-version-flag.test.mjs does scan packages/*/README.md and skills/*/SKILL.md, but it is single-purpose: its matcher only ever looks for stash eql install … --eql-version inside fenced shell blocks. It would not have caught --proxy in 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 in skills/stash-postgres and skills/stash-auth, the removal-error text at packages/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 of main, 291 files, +10,971/−30,202, and it touches packages/protect/README.md and packages/schema/README.md — pre-rename paths that would resurrect deleted packages. Do not close #816 by merging it.

Verification

  • The table now matches registry.ts:119-138 one-for-one — all four init flags, no extras — on this branch and on origin/main.
  • grep -i proxy packages/stack/README.md returns nothing, so the deleted row was not the anchor for any surrounding prose.
  • git grep -E '\-\-proxy|--no-proxy' over shipped READMEs and skills/**: no hits. Remaining repo hits are intentional — the product CipherStash Proxy in skills/stash-postgres and skills/stash-auth (explicitly framed as a different path), the removal-error text in packages/cli/src/bin/main.ts:305, v2 eql_v2_configuration in packages/cli/src/commands/db/status.ts, internal docs/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.
  • Biome does not process markdown, so code:check is a no-op on both files.
  • No interaction with feat: rename @cipherstash/prisma-next to @cipherstash/stack-prisma for 1.0 #844 (the @cipherstash/prisma-next@cipherstash/stack-prisma rename, merged as d2772b0c after this branch was cut): it leaves packages/stack/README.md untouched and the --prisma-next flag 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/stack already carries a minor this 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 push residue in packages/wizard/README.md — was already fixed by 0fc041ac (#838, merged 2d7ef563). That comment was written ~1h before #838 landed. No wizard change is needed here.

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
@tobyhede
tobyhede requested a review from a team as a code owner July 30, 2026 04:22
@changeset-bot

changeset-bot Bot commented Jul 30, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: ff70532

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 11 packages
Name Type
@cipherstash/stack Patch
@cipherstash/bench Patch
stash Patch
@cipherstash/prisma-next Patch
@cipherstash/stack-drizzle Patch
@cipherstash/stack-supabase Patch
@cipherstash/test-kit Patch
@cipherstash/basic-example Patch
@cipherstash/prisma-next-example Patch
@cipherstash/e2e Patch
@cipherstash/wizard Patch

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

@coderabbitai

coderabbitai Bot commented Jul 30, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@tobyhede, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 21 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f1031b77-51df-4804-bf43-008817dd4557

📥 Commits

Reviewing files that changed from the base of the PR and between d2772b0 and ff70532.

📒 Files selected for processing (2)
  • .changeset/stack-readme-drop-proxy-flags.md
  • packages/stack/README.md

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderdan

Copy link
Copy Markdown
Contributor

Approved. I'll also close #790.

@coderdan
coderdan merged commit 20cb8c3 into main Jul 30, 2026
10 checks passed
@coderdan
coderdan deleted the fix/issue-816-proxy-readme branch July 30, 2026 05:05
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.

Finish adapter correctness and release verification for the v2 removal

2 participants