1Create a ReleaseQA Account

2Install the Reporter

Install the ReleaseQA reporter package for your test framework:

Jest

npm install --save-dev @releaseqa/reporter-jest

Playwright

npm install --save-dev @releaseqa/reporter-playwright

Cypress

npm install --save-dev @releaseqa/reporter-cypress

3Get Your API Key

Navigate to your API Keys settings in the dashboard and generate a new API key. Set it as an environment variable:

export RELEASEQA_API_KEY=your_api_key_here

4Configure Your Test Runner

Add the ReleaseQA reporter to your test configuration:

jest.config.js

module.exports = {
  reporters: [
    'default',
    ['@releaseqa/reporter-jest', {
      apiKey: process.env.RELEASEQA_API_KEY,
      projectId: 'your-project-id',
    }],
  ],
};

playwright.config.ts

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

export default defineConfig({
  reporter: [
    ['list'],
    ['@releaseqa/reporter-playwright', {
      apiKey: process.env.RELEASEQA_API_KEY,
      projectId: 'your-project-id',
    }],
  ],
});

5Run Your Tests

Run your test suite as usual. Results will be automatically reported to ReleaseQA:

npx jest

Check your dashboard to see your test results, quality scores, and flaky test detection.

Quick Start Guide

1Create a ReleaseQA Account

2Install the Reporter

3Get Your API Key

4Configure Your Test Runner

5Run Your Tests

Next Steps

Installation Guide

Configuration