playwright-github-actions-reporter
playwright-github-actions-reporter copied to clipboard
estruyf
GitHub Actions reporter for Playwright
trafficstars
GitHub Actions Reporter for Playwright
This action reports test results from Playwright to GitHub summaries.
Installation
Install from npm:
npm install @estruyf/github-actions-reporter
Usage
You can configure the reporter by adding it to the playwright.config.js file:
import { defineConfig } from '@playwright/test';
export default defineConfig({
reporter: [
['list'],
['@estruyf/github-actions-reporter']
],
});
More information on how to use reporters can be found in the Playwright documentation.
Configuration
The reporter supports the following configuration options:
| Option | Description | Default |
|---|---|---|
| title | Title of the report. Use an empty string ("") to remove the heading. |
Test results |
| useDetails | Use details in summary which creates expandable content | false |
| showAnnotations | Show annotations from tests | true |
| showTags | Show tags from tests | true |
| showError | Show error message in summary | false |
| includeResults | Define which types of test results should be shown in the summary | ['pass', 'skipped', 'fail', 'flaky'] |
| quiet | Do not show any output in the console | false |
To use these option, you can update the reporter configuration:
import { defineConfig } from '@playwright/test';
import type { GitHubActionOptions } from '@estruyf/github-actions-reporter';
export default defineConfig({
reporter: [
['@estruyf/github-actions-reporter', <GitHubActionOptions>{
title: 'My custom title',
useDetails: true,
showError: true
}]
],
});
Example without details
Example with details
estruyf