Skip to content

Document staging E2E environment #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BASIC-BIT merged 1 commit into from
May 30, 2026
Merged

Document staging E2E environment #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/deployment/convex-environments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@ Development/staging Convex env names:

The browser-facing token stays in the web host and GitHub Actions as `VRDEX_E2E_BROWSER_TOKEN` / `VRDEX_HOSTED_E2E_BROWSER_TOKEN`; it is not needed by Convex.

The shared development deployment `scrupulous-corgi-247` is the current hosted E2E backend for Vercel `staging`. If new Convex functions are required for hosted E2E, push them to the dev deployment before rerunning deployed health:

```powershell
$env:CONVEX_DEPLOYMENT="dev:scrupulous-corgi-247"; $env:CONVEX_SELF_HOSTED_URL=""; pnpm exec convex dev --once --typecheck=try --tail-logs=disable
```
Comment on lines +45 to +47
Copy link
Copy Markdown

@greptile-apps greptile-apps Bot May 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Missing POSIX shell equivalent for Convex push command

Every other shell command in these docs comes in both a PowerShell and a POSIX shell form (see playwright-visual-preview.md, which provides paired powershell and sh blocks throughout). A developer on Linux or macOS who needs to push Convex functions to the dev deployment has no direct equivalent here and would have to manually translate the $env:VAR="value" syntax to VAR=value prefix form.

Prompt To Fix With AI 
This is a comment left during a code review.
Path: docs/deployment/convex-environments.md
Line: 45-47

Comment:
**Missing POSIX shell equivalent for Convex push command**

Every other shell command in these docs comes in both a PowerShell and a POSIX shell form (see `playwright-visual-preview.md`, which provides paired `powershell` and `sh` blocks throughout). A developer on Linux or macOS who needs to push Convex functions to the dev deployment has no direct equivalent here and would have to manually translate the `$env:VAR="value"` syntax to `VAR=value` prefix form.

How can I resolve this? If you propose a fix, please make it concise.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!


## Notes

There are two similarly named Convex projects in the account history: `vrdex` and `vrdex-85631`. Current recommendation is to keep the `vrdex` line of deployments and archive/delete the other only after confirming no dashboard, env, or deployment history still depends on it.
25 changes: 25 additions & 0 deletions docs/deployment/vercel-preview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,31 @@ Production should keep `VRDEX_ENABLE_E2E_HELPERS=false` or unset, and should not

Preview deployment protection must allow unauthenticated reads if the PR preview is meant to be reviewed outside the Vercel dashboard.

## Staging Hosted E2E Environment

Locked decision: `staging` is the shared non-production Vercel custom environment for deployed mutation-backed Playwright health checks.

- target name: `staging`
- type: Preview custom environment
- branch tracking: `staging`
- stable alias: `https://vr-dex-web-env-staging-basicbit.vercel.app`
- deploy command from the repository root: `pnpm dlx vercel@54.4.1 deploy --target=staging --yes`

The `staging` Vercel environment points at the shared Convex development deployment:

- `NEXT_PUBLIC_CONVEX_URL=https://scrupulous-corgi-247.convex.cloud`
- `CONVEX_URL=https://scrupulous-corgi-247.convex.cloud`
- `VRDEX_REQUIRE_CONVEX_URL=true`
- `NEXT_PUBLIC_VRDEX_SUBMISSIONS_AUTH_READY=false`
- `VRDEX_ENABLE_E2E_HELPERS=true`
- `VRDEX_E2E_BROWSER_TOKEN`: sensitive value matching GitHub Actions secret `VRDEX_HOSTED_E2E_BROWSER_TOKEN`
- `VRDEX_E2E_CONVEX_SECRET`: sensitive value matching Convex dev env `VRDEX_E2E_CONVEX_SECRET`

GitHub Actions uses these repository settings for hosted mutation health:

- variable `VRDEX_HOSTED_E2E_BASE_URL=https://vr-dex-web-env-staging-basicbit.vercel.app`
- secret `VRDEX_HOSTED_E2E_BROWSER_TOKEN`

## Validation

The Vercel build runs `pnpm build:vercel`, which executes `apps/web/scripts/check-vercel-env.mjs` before `next build`.
Expand Down
2 changes: 2 additions & 0 deletions docs/testing/playwright-visual-preview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,3 +133,5 @@ The `Deployed Health Checks` workflow runs after merges to `main`, after success
- `Production Smoke Health` uses the production deployment status URL when the workflow was triggered by a successful production deployment, otherwise `VRDEX_PRODUCTION_SMOKE_BASE_URL`, to run read-only public route smoke against production.

Manual dispatch can run `all`, `staging-mutation`, or `production-smoke`. The optional `base_url` override applies only when dispatching a single selected target. The deployed health workflow uploads artifacts and fails the workflow on test failure, but it does not create GitHub issues automatically.

Current hosted mutation target: `https://vr-dex-web-env-staging-basicbit.vercel.app`, backed by the shared Convex development deployment. The deployed health workflow run `26682711966` passed `staging-mutation` after the Vercel staging environment and Convex dev E2E helper variables were configured.
Loading