Appearance
github.checks.await_ref ​
Wait for one commit's required GitHub checks to reach a terminal result, or report honestly that they did not settle in time.
Wait for one commit's required GitHub checks to reach a terminal result.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-github |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
actor | string | No | — | — |
workflow_run_id | string | No | — | — |
github_connection_uuid | uuid | No | — | — |
repository | string | Yes | — | — |
commit_sha | string | Yes | — | — |
required_check_names | list | No | — | — |
allow_no_checks | boolean | No | — | — |
deadline_seconds | integer | No | — | — |
interval_seconds | integer | No | — | — |
waited_seconds | integer | No | — | — |
polls | integer | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
status | string | No | — | — |
organization_uuid | uuid | No | — | — |
allow_no_checks | boolean | No | — | — |
repository | string | No | — | — |
commit_sha | string | No | — | — |
green | boolean | No | — | — |
check_runs | list | No | — | — |
commit_statuses | list | No | — | — |
required_check_names | list | No | — | — |
missing_checks | list | No | — | — |
pending_checks | list | No | — | — |
failed_checks | list | No | — | — |
timed_out_checks | list | No | — | — |
cancelled_checks | list | No | — | — |
stale_checks | list | No | — | — |
timed_out | boolean | No | — | — |
waited_seconds | integer | No | — | — |
polls | integer | No | — | — |
deadline_seconds | integer | No | — | — |
interval_seconds | integer | No | — | — |
warnings | list | No | — | — |
failure_reason | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
failed_at_state | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failed_at | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | poll | — |
waiting | No | No | — | — | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | poll | waiting | — |
waiting | poll | waiting | — |
waiting | settle | completed | — |
pending | settle | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "github.checks.await_ref",
"initial_data": {
"organization_uuid": "value",
"repository": "value",
"commit_sha": "value"
}
}