ReleaseReady Docs
Practical implementation guidance for Playwright JavaScript/TypeScript teams.
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 testSuggested repo files
jsonCopy/paste friendly
{
"scripts": {
"test:e2e": "playwright test"
}
}ReleaseReady setup
- Create a ReleaseReady project.
- Save the GitHub repo URL.
- Add a checklist template with tags such as
@smokeand@regression. - If you are using the external runner, make sure it can run the same repo command you trust locally.
- 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:
reporeftagsplaywrightImage
Make sure your runner accepts those fields and posts results back to ReleaseReady.
Common JS setup issues
npm cifails becausepackage-lock.jsonis out of sync.- Playwright browsers are missing in the execution environment.
- The repo needs extra environment variables that were not configured in the runtime.