gitops.dispatch-on-event ​
Fan a GitHub push/release event out to matching gitops.sync reconciles
Find the GitOpsApplications a git event should sync and start a reconcile for each. Intended to be invoked as a step in the github.push / github.release DAGs.
Inputs:
- organization_uuid: org the webhook resolved to (required).
- github_repository_uuid: GitHubRepository UUID from the webhook DAG (required).
- branch: pushed branch name (push events).
- is_release: True for release/tag events.
Composes data.gitops.application.list-for-repo, then starts gitops.sync per match (async, trigger=webhook).
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-gitops |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
github_repository_uuid | uuid | Yes | — | — |
branch | string | No | — | — |
is_release | boolean | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
dispatched | integer | No | — | — |
application_uuids | json | No | — | — |
sync_workflow_ids | json | No | — | — |
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 | — | dispatch | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | dispatch | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "gitops.dispatch-on-event",
"initial_data": {
"organization_uuid": "value",
"github_repository_uuid": "value"
}
}