Appearance
github.push-sync-branch ​
Sync branch record to DB
Sync branch to DB (create/update/delete)
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-github |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
repository_uuid | uuid | Yes | — | Repository UUID |
organization_uuid | string | No | — | Organization UUID (public) |
ref | string | Yes | — | Full ref (refs/heads/main) |
branch_name | string | Yes | — | Branch name |
head_sha | string | No | — | HEAD commit SHA |
head_commit | dict | No | — | Head commit details |
is_deleted | boolean | Yes | — | Whether branch was deleted |
is_created | boolean | Yes | — | Whether branch was created |
workflow_run_id | string | No | — | Parent DAG run ID |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
branch_uuid | uuid | No | — | — |
action_performed | 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 | — |
executing | No | No | — | complete | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | executing | — |
executing | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "github.push-sync-branch",
"initial_data": {
"repository_uuid": "value",
"ref": "value",
"branch_name": "value",
"is_deleted": true
}
}