Playwright + TypeScript Quickstart

This guide is for TypeScript Playwright repositories.

Repository baseline

Your repository should already be able to run something similar locally:

npm install
npx playwright install
npx playwright test

Suggested repo files

{
  "scripts": {
    "test:e2e": "playwright test"
  }
}

import { defineConfig } from '@playwright/test';

export default defineConfig({
  testDir: './tests',
});

ReleaseReady setup

1. Create a project.
2. Save the GitHub repo URL.
3. Add a checklist template with tags matching the suites you care about.
4. Configure GitHub webhook delivery if you want pull-request driven automation.
5. Trigger a first run manually before relying on automated triggers.

Practical first run

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

If your repo needs a build step, include it explicitly in the command.

TypeScript-specific notes

• Your repo should include the TypeScript config and Playwright config it already needs locally.
• ReleaseReady does not generate project files for you; it runs the repository you connect.
• If you use delegated runner mode, the runner environment needs the same dependencies your TypeScript test workflow expects.

Related guides

• Connect a repo
• Trigger-based runs
• Troubleshooting