Appearance
github.push ​
Handles GitHub App push webhooks (DAG)
DAG-based GitHub push workflow.
Handles GitHub App push webhooks with parallel-capable structure. Uses atomic workflows for step execution.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Dag |
| Library | App-github |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
delivery_ref | string | Yes | — | Webhook delivery ID |
event_type | string | Yes | — | Webhook event type |
action | string | No | — | Webhook action (empty for push) |
payload | dict | Yes | — | Webhook payload |
organization_uuid | string | No | — | Organization UUID (public) |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
delivery_ref | string | No | — | — |
event_type | string | No | — | — |
action | string | No | — | — |
payload | dict | No | — | — |
organization_uuid | string | No | — | — |
workflow_run_uuid | string | No | — | — |
check_auto_deploy | dict | No | — | — |
check_gitops | dict | No | — | — |
complete | dict | No | — | — |
dispatch_staff_event | dict | No | — | — |
record_push | dict | No | — | — |
sync_branch | dict | No | — | — |
validate | dict | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | integer | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
DAG Layers ​
| # | Layer | Steps | Compensation |
|---|---|---|---|
| 1 | validate | github.push-validate | — |
| 2 | sync_branch | github.push-sync-branch | — |
| 3 | record_push | github.push-record | — |
| 4 | check_auto_deploy | github.push-check-auto-deploy, github.push-check-gitops, staff.dispatch-event-to-actor | — |
| 5 | complete | github.push-complete | — |
Execution Flow ​
Sub-workflows ​
| Sub-workflow | Step name |
|---|---|
github.push-validate | validate |
github.push-sync-branch | sync_branch |
github.push-record | record_push |
github.push-check-auto-deploy | check_auto_deploy |
github.push-check-gitops | check_gitops |
staff.dispatch-event-to-actor | dispatch_staff_event |
github.push-complete | complete |
Business Errors ​
| Code | Message Template |
|---|---|
DELIVERY_ID_REQUIRED | delivery_ref is required |
REPOSITORY_NOT_FOUND | GitHub repository not found |
REF_REQUIRED | ref is required |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "github.push",
"initial_data": {
"delivery_ref": "value",
"event_type": "value",
"payload": "value"
}
}