Quick Start

Create an API key to authenticate your CI pipeline with Exolar QA.

1. Go to Settings → API Keys
2. Click "Create API Key"
3. Give it a descriptive name (e.g., "GitHub Actions")
4. Copy the key (it starts with exolar_)

Add the Exolar QA Playwright reporter to your project:

npm install -D @exolar-qa/playwright-reporter

Or with yarn/pnpm:

yarn add -D @exolar-qa/playwright-reporter
# or
pnpm add -D @exolar-qa/playwright-reporter

Add the reporter to your playwright.config.ts:

// playwright.config.ts
import { defineConfig } from "@playwright/test";
import { exolar } from "@exolar-qa/playwright-reporter";

export default defineConfig({
  reporter: [
    ["html"],
    [exolar, {
      apiKey: process.env.EXOLAR_API_KEY,
    }]
  ],

  use: {
    screenshot: "only-on-failure",
    video: "retain-on-failure",
    trace: "retain-on-failure",
  },
});

Add your API key to GitHub repository secrets:

1. Go to your GitHub repository
2. Click Settings → Secrets and variables → Actions
3. Click "New repository secret"
4. Name: EXOLAR_API_KEY
5. Value: Paste your API key from Step 1

Pass the API key to your test workflow:

# .github/workflows/playwright.yml
name: Playwright Tests

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
      - run: npm ci
      - run: npx playwright install --with-deps chromium
      - run: npx playwright test
        env:
          EXOLAR_API_KEY: ${{ secrets.EXOLAR_API_KEY }}

Push a commit to trigger your workflow. After the tests run, you'll see results appear in your Exolar QA dashboard within seconds.

[Exolar] Initialized - will send results to dashboard
[Exolar] Sending 15 results to dashboard...
[Exolar] Results sent successfully - execution_id: 123