Skip to content

Document staging E2E environment#105

Merged
BASIC-BIT merged 1 commit into
mainfrom
chore/document-staging-e2e-environment
May 30, 2026
Merged

Document staging E2E environment#105
BASIC-BIT merged 1 commit into
mainfrom
chore/document-staging-e2e-environment

Conversation

@BASIC-BIT
Copy link
Copy Markdown
Owner

What changed

  • Records the Vercel custom environment staging and its stable hosted E2E alias.
  • Documents the GitHub Actions and Vercel env names used for hosted mutation health without secret values.
  • Records the Convex dev deployment push command needed when hosted E2E functions change.

Testing

Risk

Docs-only repository change. Provider settings were already created and validated.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 30, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
vr-dex-web Ready Ready Preview, Comment May 30, 2026 11:34am

Request Review

@github-actions
Copy link
Copy Markdown

Playwright Hosted Data-Flow

Outcome: success
Target: https://vr-dex-web-env-staging-basicbit.vercel.app
Run: https://github.com/BASIC-BIT/VRDex/actions/runs/26682761276
Artifact: playwright-hosted-data-flow

This optional check runs the mutation-backed profile flow against a configured hosted dev/staging target with isolated E2E test data.

@github-actions
Copy link
Copy Markdown

Playwright Data-Flow Preview

Outcome: success
Run: https://github.com/BASIC-BIT/VRDex/actions/runs/26682761276
Artifact: playwright-data-flow

Captured flow:

  • test-gated profile submission form
  • gated helper rejection without the Playwright token
  • Convex profile creation
  • submission success state
  • public profile page readback
  • discovery search readback

Artifacts include screenshots, traces, and recorded video for the flow run.

@github-actions
Copy link
Copy Markdown

Playwright Image Diff

Outcome: success
Run: https://github.com/BASIC-BIT/VRDex/actions/runs/26682761276
Artifact: playwright-image-diff

Changed screenshot baselines: none in this PR.

This check compares public route screenshots against committed baselines. Inline images show only added or modified baseline PNGs.

@github-actions
Copy link
Copy Markdown

Playwright Public Screenshot Preview

Outcome: success
Run: https://github.com/BASIC-BIT/VRDex/actions/runs/26682761276
Artifact: playwright-public-preview

Screenshots: all public route checks passed on desktop and mobile.

Full screenshot set is available in the artifact. Pixel diff baselines are handled by the separate Playwright Image Diff check.

@BASIC-BIT BASIC-BIT marked this pull request as ready for review May 30, 2026 11:37
@BASIC-BIT BASIC-BIT merged commit 1686d93 into main May 30, 2026
17 checks passed
@BASIC-BIT BASIC-BIT deleted the chore/document-staging-e2e-environment branch May 30, 2026 11:37
@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, add credits to your account and enable them for code reviews in your settings.

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented May 30, 2026

Greptile Summary

This docs-only PR records the Vercel staging custom environment and its stable E2E alias, documents the GitHub Actions and Vercel env variable names used for hosted mutation health checks, and adds the Convex dev deployment push command needed when hosted E2E functions change.

  • docs/deployment/vercel-preview.md: Adds a "Staging Hosted E2E Environment" section with the target name, stable alias URL, pinned deploy command, all env var names (no secret values), and the corresponding GitHub Actions variable and secret names.
  • docs/deployment/convex-environments.md: Links the scrupulous-corgi-247 dev deployment to the Vercel staging environment and adds a PowerShell command to push Convex functions to it.
  • docs/testing/playwright-visual-preview.md: Appends the current hosted mutation target URL and a reference to the passing health check run.

Confidence Score: 4/5

Safe to merge — all changes are documentation only, no secret values are exposed, and the documented configuration aligns with the existing env var naming conventions throughout the codebase.

The PowerShell-only Convex push command in convex-environments.md breaks the established pattern of providing both PowerShell and POSIX shell variants for every runnable command, leaving Linux/macOS developers without a directly usable form.

docs/deployment/convex-environments.md — the new Convex push command block is PowerShell-only.

Important Files Changed

Filename Overview
docs/deployment/convex-environments.md Adds a note linking the scrupulous-corgi-247 dev deployment to the Vercel staging environment, plus a PowerShell-only push command; the existing docs pattern always provides a matching POSIX shell variant.
docs/deployment/vercel-preview.md Adds a new "Staging Hosted E2E Environment" section that records the Vercel custom environment config, env var names (no secret values), stable alias URL, pinned deploy command, and corresponding GitHub Actions settings — all consistent with the existing doc structure.
docs/testing/playwright-visual-preview.md Appends a single sentence recording the current hosted mutation target URL and referencing the passing health check run — purely informational, no issues.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[GitHub Actions\nDeployed Health Checks] -->|VRDEX_HOSTED_E2E_BASE_URL\nVRDEX_HOSTED_E2E_BROWSER_TOKEN| B[Playwright\nstaging-mutation run]
    B -->|HTTP requests| C[Vercel staging\nvr-dex-web-env-staging-basicbit.vercel.app]
    C -->|NEXT_PUBLIC_CONVEX_URL\nCONVEX_URL| D[Convex dev deployment\nscrupulous-corgi-247]
    C -->|VRDEX_ENABLE_E2E_HELPERS=true\nVRDEX_E2E_BROWSER_TOKEN\nVRDEX_E2E_CONVEX_SECRET| C
    D -->|VRDEX_ENABLE_E2E_HELPERS=true\nVRDEX_E2E_CONVEX_SECRET| D
    E[Developer\nPowerShell] -->|convex dev --once\nCONVEX_DEPLOYMENT=dev:scrupulous-corgi-247| D
Loading
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
docs/deployment/convex-environments.md:45-47
**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.

Reviews (1): Last reviewed commit: "Document staging E2E environment" | Re-trigger Greptile

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

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!

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