1.9.6 • Published 5 months ago

@midleman/github-actions-reporter v1.9.6

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

GitHub Actions Reporter for Playwright

This action reports test results from Playwright to GitHub summaries.

This repository is a fork with enhancements focused on result formatting. Key differences include:

  • Minimal Header: The header line has been removed for a cleaner look.
  • Emoji Summary: Summaries now feature emojis for improved readability.

Source repo

This fork

This fork

This fork

Installation

npm install @midleman/github-actions-reporter
yarn add @midleman/github-actions-reporter --dev

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"], ["@midleman/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:

OptionDescriptionDefault
titleTitle of the report. Use an empty string ("") to remove the heading.Test results
useDetailsUse details in summary which creates expandable contentfalse
showAnnotationsShow annotations from teststrue
showTagsShow tags from teststrue
showErrorShow error message in summaryfalse
includeResultsDefine which types of test results should be shown in the summary['pass', 'skipped', 'fail', 'flaky']
quietDo not show any output in the consolefalse

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: [
    [
      "@midleman/github-actions-reporter",
      <GitHubActionOptions>{
        title: "My custom title",
        useDetails: true,
        showError: true,
      },
    ],
  ],
});

Example without details

Example without details

Example with details

Example with details

Visitors

1.9.6

5 months ago

1.9.5

12 months ago

1.9.4

12 months ago

1.9.3

12 months ago