@deploysentinel/playwright

DeploySentinel Playwright Reporter

Enables viewing/debugging Playwright runs from remote environments (ex. CI) with debug information you're used to having locally.

Installation

Install the Playwright reporter into your Playwright project.

npm install -D @deploysentinel/playwright

Usage

Add Reporter

In your playwright config file (ex. playwright.config.ts) add:

import type { PlaywrightTestConfig } from '@playwright/test';

const config: PlaywrightTestConfig = {
  reporter: '@deploysentinel/playwright',
  use: {
    /* Make sure this is not 'off' so debugger can upload trace info */
    trace: 'on',
  },
};
export default config;

Add API Key

Lastly, export your API key to the OS environment variable DEPLOYSENTINEL_API_KEY. You can grab your API key by logging into/signing up for DeploySentinel and visiting your team page: https://deploysentinel.com/team.

DEPLOYSENTINEL_API_KEY=YOUR_API_KEY

Debugging

To display internal debug logs, set the environment variable DEPLOYSENTINEL_LOG_VERBOSE to 1, yes, or true.

DEPLOYSENTINEL_LOG_VERBOSE=1 ('1', 'yes' or 'true')

Run Playwright with an API Key

DEPLOYSENTINEL_API_KEY=xxx npx playwright test