ReleaseReady Docs

Practical implementation guidance for Playwright JavaScript/TypeScript teams.

Getting Started

Connect a repo

How to create a project, store the GitHub repo URL, and configure webhook details.

How to connect a repo

Use this guide after creating your ReleaseReady account.

1. Create a project

In the app dashboard:

  1. Sign in.
  2. Create a new project.
  3. Enter a project name.
  4. Save the GitHub repository URL for the Playwright repo.

The saved repo URL is used for:

  • webhook-to-project resolution,
  • delegated runner payloads,
  • and direct source checkout in runtime execution mode.

2. Add a checklist template

Create at least one checklist template for the project. Include tagged items such as:

textCopy/paste friendly
@smoke | Smoke tests
@regression | Regression suite
@security | Security checks

Those tags are reused when ReleaseReady prepares run payloads.

3. Copy the webhook URL and secret

For GitHub-backed projects, ReleaseReady exposes:

  • a project webhook URL, and
  • a project webhook secret.

Add those values to the GitHub repository webhook configuration.

4. Verify the repo is runnable

Make sure your repository already contains the Playwright project files and a working test command.

If you plan to use delegated runner mode, the runner must accept the /run payload ReleaseReady sends.

If you plan to use direct execution mode, the runtime needs enough access to clone or download the repository and execute the configured command.

Next guides