Skip to content

Commit 48223f2

Browse files
committed
docs: clarify workflow run state transitions
1 parent 1509b28 commit 48223f2

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

content/actions/reference/workflows-and-actions/workflow-run-statuses.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,14 @@ category:
1111
contentType: reference
1212
---
1313

14-
A workflow run has a `status` while it moves through its lifecycle. After the run reaches a `completed` status, its `conclusion` describes the final result.
14+
A workflow run has a `status` while it moves through its lifecycle. After the run reaches a `completed` status, its `conclusion` describes the final result. Until then, the `conclusion` value is `null`.
15+
16+
A status is a snapshot of the workflow run's current state, not a history of transitions. For example, a sequence of `queued`, `in_progress`, `queued`, and `completed` values does not identify why the state changed. When investigating such a sequence, first compare `run_attempt`: a re-run keeps the workflow run ID and increments `run_attempt`. If the attempt did not change, inspect the workflow run logs and its related check runs for more evidence. For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/contexts#github-context) and [AUTOTITLE](/actions/how-tos/monitor-workflows/use-workflow-run-logs).
1517

1618
The workflow run list endpoints in the REST API use the `status` query parameter to filter by either status or conclusion. For more information, see [AUTOTITLE](/rest/actions/workflow-runs).
1719

20+
The values on this page apply only to workflow runs. Check suites, check runs, and commit statuses have their own status and conclusion values, and a value with the same name can have different meanings for different objects. For example, in the Checks API, `startup_failure` describes a check suite that failed during startup, while `stale` describes an incomplete check run that {% data variables.product.github %} marked stale. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).
21+
1822
## Status values
1923

2024
| Status | Description |
@@ -44,4 +48,4 @@ For more information about the conditions that cause `pending` and `waiting` sta
4448
| `timed_out` | The workflow run timed out. |
4549
| `startup_failure` | The workflow run failed during startup. |
4650

47-
The `startup_failure` value can appear as a workflow run conclusion in webhook payloads. It is not an accepted value for the `status` query parameter in the REST API workflow run list endpoints.
51+
The `startup_failure` value can appear as a workflow run conclusion in webhook payloads. It is not listed as an accepted value for the `status` query parameter in the REST API workflow run list endpoints.

0 commit comments

Comments
 (0)