Appearance
github.release-check-auto-deploy ​
Check if auto-deploy should trigger for release
Check if auto-deploy should be triggered for release
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-github |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
action | string | Yes | — | Release action |
is_draft | boolean | Yes | — | Is draft release |
repository_uuid | uuid | Yes | — | Repository UUID |
organization_uuid | string | No | — | Organization UUID (public) |
release_uuid | uuid | Yes | — | Release UUID |
tag_name | string | No | — | Release tag name (release.tag_name from the webhook payload) |
workflow_run_id | string | No | — | Parent DAG run ID |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
triggered_workflow_ref | string | No | — | — |
skipped | boolean | No | — | — |
skip_reason | string | No | — | — |
workflow_run_id | string | No | — | Parent DAG run ID |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "github.release-check-auto-deploy",
"initial_data": {
"action": "value",
"is_draft": true,
"repository_uuid": "value",
"release_uuid": "value"
}
}