Files
e2e/packages/github

@e2edev/github

The GitHub reporter for @e2edev/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 @e2edev/github
import type { E2EConfig } from '@e2edev/e2e';
import { playwright } from '@e2edev/playwright';
import { github } from '@e2edev/github';

export default {
  targets: [{ engine: playwright({ 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. 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-docs.vercel.app/github.

License

MIT