ReleaseReady Docs

Practical implementation guidance for Playwright JavaScript/TypeScript teams.

QuickstartProduct

Core Flows

Trigger-based runs

How automated PR events fan into project runs and checklist execution.

Trigger-based runs

ReleaseReady currently supports automated pull-request driven execution through GitHub webhooks.

Trigger flow summary

  1. GitHub sends a pull request webhook.
  2. ReleaseReady verifies the signature.
  3. ReleaseReady resolves the project and template.
  4. ReleaseReady calls the same project run flow used by manual execution.
  5. The run is created, delegated, or executed directly depending on environment configuration.

Why this matters

The trigger path reuses the existing project execution route instead of maintaining a separate execution stack. That keeps behavior consistent between manual and automated runs.

Trigger payload details

For qualifying PR events, ReleaseReady forwards values such as:

  • branch or ref information from the PR head,
  • source references tied to the PR,
  • and runner-related authorization headers when configured.

Backward-compatibility note

The webhook-triggered path is intentionally preserved. The improvements in this change set add docs and UX guidance but do not replace or rename the current trigger mechanism.

Continue