Skip to content

Commit 1509b28

Browse files
committed
docs: document workflow run statuses
1 parent df4329a commit 1509b28

3 files changed

Lines changed: 49 additions & 1 deletion

File tree

content/actions/reference/workflows-and-actions/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ children:
1818
- /reusing-workflow-configurations
1919
- /metadata-syntax
2020
- /workflow-cancellation
21+
- /workflow-run-statuses
2122
- /dockerfile-support
2223
contentType: reference
2324
---
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Workflow run statuses and conclusions
3+
shortTitle: Workflow run statuses
4+
intro: Learn how status and conclusion values describe the lifecycle and result of a workflow run.
5+
versions:
6+
fpt: '*'
7+
ghes: '*'
8+
ghec: '*'
9+
category:
10+
- Manage and monitor workflow runs
11+
contentType: reference
12+
---
13+
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.
15+
16+
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).
17+
18+
## Status values
19+
20+
| Status | Description |
21+
| --- | --- |
22+
| `requested` | The workflow run was created but has not been queued. |
23+
| `queued` | The workflow run is queued. |
24+
| `pending` | The workflow run is at the front of the queue, but a concurrency limit has been reached. |
25+
| `waiting` | The workflow run is waiting for a deployment protection rule to be satisfied. |
26+
| `in_progress` | The workflow run is in progress. |
27+
| `completed` | The workflow run completed and has a conclusion. |
28+
29+
Only {% data variables.product.prodname_actions %} can set the `requested`, `pending`, and `waiting` statuses.
30+
31+
For more information about the conditions that cause `pending` and `waiting` statuses, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-when-workflows-run/control-workflow-concurrency) and [AUTOTITLE](/actions/how-tos/deploy/configure-and-manage-deployments/review-deployments).
32+
33+
## Conclusion values
34+
35+
| Conclusion | Description |
36+
| --- | --- |
37+
| `action_required` | The workflow run completed and requires action. |
38+
| `cancelled` | The workflow run was cancelled before it completed. |
39+
| `failure` | The workflow run failed. |
40+
| `neutral` | The workflow run completed with a neutral result. |
41+
| `skipped` | The workflow run was skipped. |
42+
| `stale` | The workflow run was marked stale by {% data variables.product.github %}. |
43+
| `success` | The workflow run completed successfully. |
44+
| `timed_out` | The workflow run timed out. |
45+
| `startup_failure` | The workflow run failed during startup. |
46+
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.

content/rest/actions/workflow-runs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ category:
1616

1717
## About workflow runs in {% data variables.product.prodname_actions %}
1818

19-
You can use the REST API to view, re-run, cancel, and view logs for workflow runs in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-workflow-runs %} For more information, see [AUTOTITLE](/actions/how-tos/manage-workflow-runs).
19+
You can use the REST API to view, re-run, cancel, and view logs for workflow runs in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-workflow-runs %} For reference information about `status` and `conclusion` values, see [AUTOTITLE](/actions/reference/workflows-and-actions/workflow-run-statuses). For more information, see [AUTOTITLE](/actions/how-tos/manage-workflow-runs).
2020

2121
<!-- Content after this section is automatically generated -->

0 commit comments

Comments
 (0)