https://github.com/estruyf/playwright-github-actions-reporter

GitHub Actions reporter for Playwright
https://github.com/estruyf/playwright-github-actions-reporter

github github-actions playwright playwright-reporter reporter

Last synced: 3 days ago
JSON representation

GitHub Actions reporter for Playwright

• Host: GitHub
• URL: https://github.com/estruyf/playwright-github-actions-reporter
• Owner: estruyf
• License: mit
• Created: 2023-08-17T12:22:37.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-15T12:25:36.000Z (3 months ago)
• Last Synced: 2025-01-05T06:12:38.564Z (10 days ago)
• Topics: github, github-actions, playwright, playwright-reporter, reporter
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@estruyf/github-actions-reporter
• Size: 1.13 MB
• Stars: 47
• Watchers: 2
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub Actions Reporter for Playwright

This action reports test results from Playwright to GitHub summaries.

## Installation

Install from npm:

  

```bash

npm install @estruyf/github-actions-reporter

```

## Usage

You can configure the reporter by adding it to the `playwright.config.js` file:

```ts

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](https://playwright.dev/docs/test-reporters).

## 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:

```ts

import { defineConfig } from '@playwright/test';

import type { GitHubActionOptions } from '@estruyf/github-actions-reporter';

export default defineConfig({

  reporter: [

    ['@estruyf/github-actions-reporter', {

      title: 'My custom title',

      useDetails: true,

      showError: true

    }]

  ],

});

```

### Example without details

![Example without details](./assets/example-without-details.png)

### Example with details

![Example with details](./assets/example-with-details.png)

[![Visitors](https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Festruyf%2Fplaywright-github-actions-reporter&countColor=%23263759)](https://visitorbadge.io/status?path=https%3A%2F%2Fgithub.com%2Festruyf%2Fplaywright-github-actions-reporter)