Documentation

ReleaseQA Documentation

Everything you need to integrate ReleaseQA into your development workflow and get actionable insights from your test results.

Quick Start

Get started in 5 minutes

API Reference

Complete API documentation

Get API Key

Generate your API key

Getting Started

Quick setup guides to get you running in minutes

Quick Start Guide

Get your first test run reporting in 5 minutes

Installation

Install the ReleaseQA reporter in your project

Configuration

Configure reporter options and environment variables

CI/CD Integration

Integrate with your existing CI/CD pipelines

GitHub Actions

Set up reporting in GitHub Actions workflows

GitLab CI

Configure GitLab CI pipelines

Jenkins

Integrate with Jenkins pipelines

CircleCI

Set up CircleCI orb integration

Test Frameworks

Native integrations for popular test frameworks

Jest

Jest reporter configuration

Playwright

Playwright test reporter setup

Cypress

Cypress plugin configuration

Vitest

Vitest reporter integration

API Reference

Complete API documentation for custom integrations

Authentication

API key management and authentication

Test Runs

Create and manage test runs

Results

Submit and query test results

Webhooks

Set up webhook notifications

Features

Learn about ReleaseQA capabilities

Quality Scores

Understanding your quality score

Flaky Test Detection

Identify and track flaky tests

Release Readiness

Assess release readiness

Team Collaboration

Manage teams and permissions

Need help?

Can't find what you're looking for? Our team is here to help.

Contact SupportCommunity Forum