docs: describe the GitHub Actions workflow in the README

Merged
KA
3d ago
+31-16

The README was still the generic Next.js example copy and never mentioned the workflow.

Changes

  • Explain what .github/workflows/e2e.yml does: install, Chromium cache, JUnit reporter, the e2e-report artifact, and cancelling stale PR runs.
  • Explain how to add the AI_GATEWAY_API_KEY repository secret, and that agent tests skip without it (including on fork PRs).
  • Keep the local run steps under "Run locally" and link the GitHub Actions guide.
  • Update the last-checked versions to e2e 0.23.0, @e2e-dev/web 0.15.5, Next.js 16.4, and Node 24.

Testing

Ran npx e2e run with an empty AI_GATEWAY_API_KEY: 3 locator tests passed, 2 agent tests skipped.

Fixes ENG-1138