Appearance
github.push-check-gitops ​
Trigger gitops.dispatch-on-event for the pushed branch (GitOps fan-out)
Fan a GitHub push out to GitOps applications tracking the pushed branch
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-github |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
repository_uuid | uuid | Yes | — | — |
organization_uuid | string | No | — | — |
branch_name | string | No | — | — |
is_deleted | boolean | No | — | — |
workflow_run_id | string | No | — | Parent DAG run ID |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
skipped | boolean | No | — | — |
skip_reason | string | No | — | — |
dispatched | integer | No | — | — |
application_uuids | list | No | — | — |
dispatch_workflow_ref | string | No | — | Workflow id of the dispatched gitops.dispatch-on-event run |
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.push-check-gitops",
"initial_data": {
"repository_uuid": "value"
}
}