Getting Started

Configuration

Configure reporter options, environment variables, and advanced settings for your ReleaseQA integration.

Environment Variables

Environment variables are the recommended way to configure ReleaseQA, especially in CI/CD environments. They take precedence over config file options.

RELEASEQA_API_KEYRequired

Your ReleaseQA API key. Get one from the dashboard under Settings → API Keys.

RELEASEQA_PROJECT_IDOptional

The project ID to report results to. Can also be set in the reporter config.

RELEASEQA_RUN_NAMEOptional

Custom name for the test run. Defaults to the git branch name or timestamp.

RELEASEQA_ENVIRONMENTOptional

The environment label (e.g., "staging", "production", "ci"). Defaults to "ci" in CI environments.

RELEASEQA_BASE_URLOptional

Custom API base URL. Only needed for self-hosted or enterprise setups.

RELEASEQA_DISABLEOptional

Set to "true" to disable reporting without removing the reporter. Useful for local development.

Reporter Config Options

These options can be passed directly to the reporter in your test framework configuration file.

Option	Type	Default	Description
`apiKey`	string	process.env.RELEASEQA_API_KEY	Your ReleaseQA API key.
`projectId`	string	—	The project ID to report results to.
`runName`	string	Auto-generated	Custom name for the test run.
`environment`	string	"ci"	Environment label for the test run.
`tags`	string[]	[]	Tags to associate with the test run for filtering.
`branch`	string	Auto-detected from git	The git branch name.
`commitSha`	string	Auto-detected from git	The git commit SHA.
`quiet`	boolean	false	Suppress ReleaseQA console output.
`failOnError`	boolean	false	Fail the test run if reporting encounters an error (e.g., network issue).
`batchSize`	number	50	Number of test results to send in each batch.

Full Configuration Example

Jest

// jest.config.js
module.exports = {
  reporters: [
    'default',
    ['@releaseqa/reporter-jest', {
      apiKey: process.env.RELEASEQA_API_KEY,
      projectId: 'my-project',
      runName: 'Unit Tests - Main',
      environment: 'ci',
      tags: ['unit', 'main-branch'],
      quiet: false,
      failOnError: false,
      batchSize: 100,
    }],
  ],
};

Playwright

// playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [
    ['list'],
    ['@releaseqa/reporter-playwright', {
      apiKey: process.env.RELEASEQA_API_KEY,
      projectId: 'my-project',
      environment: process.env.CI ? 'ci' : 'local',
      tags: ['e2e', 'playwright'],
      quiet: process.env.CI === 'true',
    }],
  ],
});

CI/CD Setup

In CI/CD environments, set the API key as a secret environment variable:

GitHub Actions

env:
  RELEASEQA_API_KEY: ${{ secrets.RELEASEQA_API_KEY }}
  RELEASEQA_ENVIRONMENT: ci
  RELEASEQA_RUN_NAME: ${{ github.ref_name }} - ${{ github.run_number }}

GitLab CI

variables:
  RELEASEQA_API_KEY: $RELEASEQA_API_KEY
  RELEASEQA_ENVIRONMENT: ci

Disabling the Reporter

To disable the reporter without removing it from your configuration (useful for local development):

RELEASEQA_DISABLE=true npx jest

You can also add this to a .env.local file to disable it by default during local development.