Skip to content

docs: describe the GitHub Actions workflow in the README - #4

Merged
kacperkapusciak merged 1 commit into
mainfrom
kacper/eng-1138-docsexamples-describe-the-workflow-in-the
Nov 9, 2026
Merged

kacperkapusciak merged 1 commit into
mainfrom
kacper/eng-1138-docsexamples-describe-the-workflow-in-the

Conversation

@kacperkapusciak

@kacperkapusciak kacperkapusciak commented Nov 9, 2026 •

Copy link
Copy Markdown
Member

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

View guided diff Turn on auto-fix

@linear-code

linear-code Bot commented Nov 9, 2026 •

Copy link
Copy Markdown
ENG-1138 docs(examples): describe the workflow in the e2e-github-actions README

The e2e-github-actions example README is still the generic Next.js copy. It does not mention the GitHub Actions workflow, the AI_GATEWAY_API_KEY repository secret, or the uploaded report artifact. Its "last checked" versions are also out of date.

Rewrite it to explain the workflow in .github/workflows/e2e.yml and update the versions.

Related: ENG-1084

Review in Linear

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

No issues found across 1 file

View guided diff | Turn on auto-fix | Re-trigger cubic

@kacperkapusciak
kacperkapusciak merged commit a0df8ec into main Nov 9, 2026
2 checks passed
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