ReleaseReady Docs

Practical implementation guidance for Playwright JavaScript/TypeScript teams.

QuickstartProduct

Getting Started

Playwright + JavaScript Quickstart

Practical setup guide for JavaScript Playwright repositories.

Playwright + JavaScript Quickstart

This guide is for JavaScript repositories that already run Playwright locally.

Repository baseline

Your repository should already contain something similar to:

bashCopy/paste friendly
npm install
npx playwright install
npx playwright test

Suggested repo files

jsonCopy/paste friendly
{
  "scripts": {
    "test:e2e": "playwright test"
  }
}

ReleaseReady setup

  1. Create a ReleaseReady project.
  2. Save the GitHub repo URL.
  3. Add a checklist template with tags such as @smoke and @regression.
  4. If you are using the external runner, make sure it can run the same repo command you trust locally.
  5. Configure the GitHub project webhook in the repo settings.

Practical first run

Manual run

Trigger a project run and use a command that maps to your repository, for example:

jsonCopy/paste friendly
{
  "projectId": "YOUR_PROJECT_ID",
  "branch": "main",
  "command": "npm ci && npx playwright test",
  "sourceRef": "manual-main"
}

Delegated runner payload expectations

The delegated runner call includes fields such as:

  • repo
  • ref
  • tags
  • playwrightImage
  • projectId (optional, but required for reliable correlation when repos are shared)
  • runId (optional, but strongly recommended)
  • callbackUrl (optional; runner should fallback to its configured default callback URL)
  • metadata (optional object; should be forwarded back unchanged)

When the runner posts results back to POST /api/runner/results, include jobId, repo, status, and preserve projectId/runId when they were present in /run.

Common JS setup issues

  • npm ci fails because package-lock.json is out of sync.
  • Playwright browsers are missing in the execution environment.
  • The repo needs extra environment variables that were not configured in the runtime.

Related guides