Files
Krzysztof Moch eddf577526 feat(reporters): build the built-in reporters on the public Reporter API (#1936)
* feat(reporters): build the built-in reporters on the public Reporter API

The built-in list, dot, json, junit, and markdown reporters now use only
the public Reporter contract: factories on e2e/reporters, printsTo for the
terminal stream a reporter prints to (one reporter per stream), live
onOutput, onStepPrompt, and onSummary hooks for any number of reporters,
and reportFiles for files the runner writes atomically. The list and dot
ids beside json print to stderr, so list,json now works as dot,json does.
@e2e-dev/html-reporter writes through reportFiles.

* docs(reporters): bring the Japanese and Chinese reporter pages up to date

Translates the reporter reference, the config reporters table, the
--reporter row, and the debugging output paragraph. In English, the name
section now says a reporter may share a built-in's name, and two lines
read less ambiguously.
2026-11-19 15:58:33 +00:00
..
2026-11-19 16:37:27 +02:00
2026-11-19 16:37:27 +02:00

@e2e-dev/github

The GitHub reporter for e2e. From GitHub Actions, every run becomes one pull request comment, edited in place on reruns, and the same text lands in the job summary.

npm install --save-dev @e2e-dev/github
import type { E2EConfig } from 'e2e';
import { web } from '@e2e-dev/web';
import { github } from '@e2e-dev/github';

export default {
  targets: [{ engine: web(), app: { url: 'http://localhost:3000' } }],
  reporters: ['list', github()],
} satisfies E2EConfig;

The job needs permissions: pull-requests: write and the step that runs e2e needs GITHUB_TOKEN: ${{ github.token }} in its env. Matrix replicas of one job pass a key so their comments stay apart, and an e2e explore run keeps a comment of its own. When the reporter cannot post (another CI, a push, a fork's read-only token) it says why in one summary row and never changes the run's exit code.

Full documentation lives at e2e.com/docs/github.

License

Apache-2.0