How it works

ReleaseReady organizes execution around a few core objects:

• **Project**: the repository and runtime settings you want ReleaseReady to manage.
• **Checklist template**: the validation items and tags you want attached to a run.
• **Checklist run**: the execution record created by a webhook, manual run, or runner sync.
• **Integration**: currently used for GitHub repository and webhook metadata.

End-to-end flow

1. Create a project and save the GitHub repository URL.
2. Add a checklist template for the project.
3. Configure GitHub to send pull request events to the project webhook URL.
4. Trigger a run either manually or through a qualifying webhook event.
5. ReleaseReady either delegates execution to the external runner service or executes directly in the app runtime, depending on environment configuration.
6. ReleaseReady stores the run, status, and summarized output.
7. The dashboard and APIs expose the run for review.

Execution modes

Delegated runner mode

When RUNNER_URL is configured, project run requests are sent to the runner /run endpoint. ReleaseReady stores the delegated job metadata and later accepts updates through POST /api/runner/results.

Direct execution mode

When no external runner is configured, ReleaseReady clones or downloads the repository in the app runtime, resolves a test command, and stores the output against the checklist run.

ReleaseReady preserves both execution modes. The product documentation in this repo intentionally reflects those current behaviors instead of describing a future multi-runner model that does not exist yet.

Learn the flow details

• Connect a repo
• Webhooks
• Manual runs
• Trigger-based runs
• Interpreting a run