Skip to content

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

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
kacperkapusciak merged 1 commit into from
Nov 9, 2026
Merged

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

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
47 changes: 31 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,48 @@
# e2e with Next.js
# e2e with GitHub Actions

A Next.js App Router greeting app with three locator tests and two agent tests.
A Next.js App Router greeting app whose e2e tests run on every pull request
and every push to `main`. It has three locator tests and two agent tests.

![Next.js example app with the greeting "hello, Ada!"](screenshot.png)

## Run
## The workflow

Use Node 22.22.3+, 24.8+, or 26+. From this folder:
[.github/workflows/e2e.yml](.github/workflows/e2e.yml) was written by
`npx e2e init --ci github-actions`. On each run it:

```bash
npm install
npm run test:e2e
```
1. Installs dependencies with `npm ci` on Node 24.
2. Restores Chromium from the cache, or installs it with
`npx e2e-web install chromium --with-deps`.
3. Runs `npx e2e run --reporter list,junit`. The app starts on its own.
4. Uploads `.e2e/report.json`, `.e2e/junit.xml`, and `.e2e/results` as the
`e2e-report` artifact, even when tests fail. The artifact is kept for 7 days.

A new push to a pull request cancels the run still in progress for it.

The runner starts the app at `http://localhost:3100`.
It downloads Chromium on the first run if needed.
## Agent tests in CI

## Agent tests
Add a [Vercel AI Gateway](https://vercel.com/docs/ai-gateway) key as a
repository secret named `AI_GATEWAY_API_KEY` (**Settings → Secrets and
variables → Actions**). Without it, the agent tests skip and the locator tests
still run.

Set a [Vercel AI Gateway](https://vercel.com/docs/ai-gateway) key:
Pull requests from forks don't get repository secrets, so their agent tests skip.

## Run locally

Use Node 22.22.3+, 24.8+, or 26+. From this folder:

```bash
npm install
AI_GATEWAY_API_KEY="your-key" npm run test:e2e
```

Without the key, the agent tests skip. Add `-- --no-cache` to use fresh
model calls. Results are in `.e2e/report.json`.
The runner starts the app at `http://localhost:3100` and downloads Chromium on
the first run if needed. Leave out the key to run only the locator tests. Add
`-- --no-cache` to use fresh model calls. Results are in `.e2e/report.json`.

See [e2e.config.ts](e2e.config.ts) and [tests/](tests/) for the setup.
For your own app, follow the [Quickstart](https://e2e.com/docs/quickstart).
For your own repository, follow the
[GitHub Actions guide](https://e2e.com/docs/ci/github-actions).

Last checked with e2e 0.22.0, @e2e-dev/web 0.15.4, Next.js 16.4, and Node 22.
Last checked with e2e 0.23.0, @e2e-dev/web 0.15.5, Next.js 16.4, and Node 24.
Loading