ReleaseReady Docs

Practical implementation guidance for Playwright JavaScript/TypeScript teams.

Getting Started

Quickstart

Fastest path from signup to first successful run.

Quickstart

This is the fastest route from zero to a first successful ReleaseReady run.

Get started in minutes

  1. Create a project and connect the GitHub repository URL.
  2. Add a checklist template with Playwright-related tags.
  3. Copy the project webhook URL and secret into GitHub, or prepare to trigger a manual run.
  4. Trigger the first run.
  5. Review the run status, output, and checklist information in the dashboard.

Environment notes

  • Delegated runner mode requires RUNNER_URL and RUNNER_SECRET in the app environment.
  • Runner result ingestion requires the same RUNNER_SECRET to be shared with the runner.
  • GitHub webhook signature validation uses the project webhook secret when present and falls back to GITHUB_WEBHOOK_SECRET if configured.

First-run success checklist

  • The repo URL is correct.
  • The project has at least one checklist template.
  • GitHub webhook configuration points at the correct project webhook URL if you want automated PR triggers.
  • The runner secret matches across app and runner environments when using delegated mode.

Continue