ReleaseReady Docs
Practical implementation guidance for Playwright JavaScript/TypeScript teams.
Core Flows
Manual runs
How to trigger runs from the dashboard or API without waiting for a webhook event.
Manual runs
Manual runs are useful when you want to validate setup before relying on automation, or when you need to rerun a branch on demand.
Current manual run paths
ReleaseReady supports:
- manual project runs through the dashboard,
POST /api/projects/{projectId}/run-tests,- and
POST /api/run, which forwards to the project run route.
Example API request
bashCopy/paste friendly
curl -X POST https://app.releaseready.dev/api/run \
-H 'Content-Type: application/json' \
-d '{
"projectId": "YOUR_PROJECT_ID",
"branch": "main",
"command": "npm ci && npx playwright test",
"timeoutMs": 300000,
"sourceRef": "manual-main"
}'What happens next
- ReleaseReady validates the request payload.
- It resolves the project and selected template, if one is provided.
- In delegated mode, it forwards execution to the external runner.
- In direct mode, it checks out the repo and runs the command itself.
Best practice
Use a manual run first when onboarding a repo. It gives you a clean signal before webhooks begin triggering runs automatically.