DEV Community

Md Salekin Newaz
Md Salekin Newaz

Posted on

How to Add Clean Markdown Test Summaries to Playwright & GitHub Actions in 60 Seconds

Playwright already has great reporting tools. Built-in HTML Reports and Trace Viewer are unbeatable for deep debugging, while Allure and Monocart are much richer if you want heavy visual reports or deep charting.

Where is the real difference in short? If you just want rich UI reports or fancy charts, Monocart or Allure offer far more. But if your goal when CI turns red is to quickly isolate failed tests, run them locally with npx playwright test <file:line>, and grab a clean error summary ready for AI, that exact focus is why playwright-summary-reporter is carving out its own space.

Why Use a Companion Markdown Summary Reporter?

  • 1-click local re-run: Generates the exact npx playwright test <file:line> command for failed tests so you can reproduce issues locally fast.
  • Local-first AI debugging prompt: Creates a structured prompt block ready for Copilot, Claude, or Cursor with failure types, file locations, and ANSI-stripped errors.
  • Deterministic error classification: Categorizes failures into Runtime, Timeout, Assertion, or Locator so you quickly tell product bugs apart from test instability.
  • GitHub Actions Job Summary (GITHUB_STEP_SUMMARY): Renders clean summary tables, per-project breakdowns, flaky retry counts, and slowest tests automatically[cite: 7].
  • Zero runtime dependencies: Built in TypeScript using Node.js built-ins (~17 kB packed)[cite: 1, 13].

Step 1: Install

npm install -D playwright-summary-reporter
Enter fullscreen mode Exit fullscreen mode

Step 2: Configure playwright.config.ts

Keep your HTML reporter for deep debugging and add playwright-summary-reporter alongside it:

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

export default defineConfig({
  reporter: [
    ['list'],
    ['html'],
    [
      'playwright-summary-reporter',
      {
        outputFile: 'playwright-summary.md',
        title: 'Playwright Test Summary',
        writeToGitHubSummary: true,
        showFailedTests: true,
        showFlakyTests: true,
        showSlowestTests: 5,
        includeProjectBreakdown: true,
      },
    ],
  ],
});
Enter fullscreen mode Exit fullscreen mode

Step 3: Run in GitHub Actions

Because writeToGitHubSummary is enabled by default, you don't need extra bash parsing steps in your workflow YAML:

name: Playwright Tests

on: [push, pull_request]

jobs:
  e2e:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npm ci
      - run: npx playwright install --with-deps chromium
      - run: npx playwright test
Enter fullscreen mode Exit fullscreen mode

Links


Written by **Md Salekin Newaz* — Senior Software QA Engineer (ISTQB®), working with Playwright, TypeScript test automation, and AI-driven QA workflows. Connect on LinkedIn[cite: 3], GitHub[cite: 3], or explore my Portfolio[cite: 4].*

Top comments (0)