Getting Started
Installation
Install the ReleaseQA reporter for your test framework. Supports npm, yarn, and pnpm.
Prerequisites
- Node.js 16 or later
- A ReleaseQA account and API key (get one here)
- A supported test framework (Jest, Playwright, Cypress, or Vitest)
Jest
Package: @releaseqa/reporter-jest
Requires: Node.js 16 or later, Jest 27 or later
npm
npm install --save-dev @releaseqa/reporter-jestyarn
yarn add --dev @releaseqa/reporter-jestpnpm
pnpm add -D @releaseqa/reporter-jestConfiguration
// jest.config.js
module.exports = {
reporters: [
'default',
['@releaseqa/reporter-jest', {
apiKey: process.env.RELEASEQA_API_KEY,
projectId: 'your-project-id',
}],
],
};Playwright
Package: @releaseqa/reporter-playwright
Requires: Node.js 16 or later, Playwright 1.20 or later
npm
npm install --save-dev @releaseqa/reporter-playwrightyarn
yarn add --dev @releaseqa/reporter-playwrightpnpm
pnpm add -D @releaseqa/reporter-playwrightConfiguration
// 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',
}],
],
});Cypress
Package: @releaseqa/reporter-cypress
Requires: Node.js 16 or later, Cypress 10 or later
npm
npm install --save-dev @releaseqa/reporter-cypressyarn
yarn add --dev @releaseqa/reporter-cypresspnpm
pnpm add -D @releaseqa/reporter-cypressConfiguration
// cypress.config.js
const { defineConfig } = require('cypress');
const { releaseQAPlugin } = require('@releaseqa/reporter-cypress');
module.exports = defineConfig({
e2e: {
setupNodeEvents(on, config) {
releaseQAPlugin(on, config, {
apiKey: process.env.RELEASEQA_API_KEY,
projectId: 'your-project-id',
});
},
},
});Vitest (via CLI)
Package: @releaseqa/cli
Requires: Node.js 18 or later, Vitest 0.30 or later
npm
npm install --save-dev @releaseqa/cliyarn
yarn add --dev @releaseqa/clipnpm
pnpm add -D @releaseqa/cliConfiguration
// vitest.config.ts — there is no dedicated Vitest reporter yet.
// Have Vitest write JUnit XML, then send it with the CLI after the run.
import { defineConfig } from 'vitest/config';
export default defineConfig({
test: {
reporters: ['default', 'junit'],
outputFile: { junit: './test-results/junit.xml' },
},
});
// after `vitest run` (locally or in CI):
// npx @releaseqa/cli report --format junit --file ./test-results/junit.xmlCLI Tool (Optional)
You can also install the ReleaseQA CLI for manual uploads and project management:
npm install -g @releaseqa/cliTroubleshooting
Permission errors during installation
If you encounter permission errors, try running with sudo or fix your npm permissions: npm config set prefix ~/.npm-global
Network or proxy issues
If you're behind a corporate proxy, configure npm proxy settings: npm config set proxy http://proxy:8080