walshydev/CanaryRoll Deploy
Trigger a gradual deployment via CanaryRoll for Cloudflare Workers
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| api-url | CanaryRoll instance URL (e.g. https://canaryroll.example.com) | no | https://canaryroll.com |
| api-token | CanaryRoll API token (team token crt_* or user token cru_*) | yes | — |
| team-id | Team ID or slug | yes | — |
| worker-id | Worker ID (registered in CanaryRoll) | yes | — |
| version-id | Cloudflare Worker version ID to deploy | yes | — |
| plan | Rollout plan ID or slug (defaults to worker default plan) | no | — |
| auto-advance | Whether to auto-advance through rollout steps | no | true |
| name | Optional release name | no | — |
| ticket-url | Optional ticket/issue URL to associate with the deployment | no | — |
| auto-start | Automatically start the deployment after creation and preflight checks pass. If false, the deployment is left in pending status for manual start via the dashboard. | no | false |
| wait | Wait for the deployment to complete before finishing the action | no | false |
| wait-timeout | Maximum seconds to wait for deployment completion (only used if wait=true) | no | 5400 |
| poll-interval | Seconds between status polls when waiting (only used if wait=true) | no | 30 |
| cf-access-client-id | Cloudflare Access client ID (for Access-protected instances) | no | — |
| cf-access-client-secret | Cloudflare Access client secret (for Access-protected instances) | no | — |
Outputs
| name | description |
|---|---|
| release-id | The created release ID |
| release-url | URL to view the release in the CanaryRoll dashboard |
| status | Release status (pending, in_progress, completed, rolled_back, failed) |