Skip to content

Commit ce913b7

Browse files
committed
fix the changes
1 parent bb2e3d8 commit ce913b7

File tree

9 files changed

+93
-0
lines changed

9 files changed

+93
-0
lines changed

content/actions/how-tos/manage-workflow-runs/approve-runs-from-forks.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ redirect_from:
1616
- /actions/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-private-forks
1717
---
1818

19+
{% data reusables.actions.workflow-run-statuses-2 %}
20+
1921
Workflow runs triggered by a contributor's pull request from a fork may require manual approval from a maintainer with write access. You can configure workflow approval requirements for a [repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-required-approval-for-workflows-from-public-forks), [organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#configuring-required-approval-for-workflows-from-public-forks), or [enterprise](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-fork-pull-requests-in-your-enterprise).
2022

2123
Workflow runs that have been awaiting approval for more than 30 days are automatically deleted.

content/actions/how-tos/manage-workflow-runs/cancel-a-workflow-run.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ redirect_from:
1313
- /actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/canceling-a-workflow
1414
---
1515

16+
{% data reusables.actions.workflow-run-statuses-2 %}
17+
1618
## Canceling a workflow run
1719

1820
{% data reusables.repositories.navigate-to-repo %}

content/actions/how-tos/manage-workflow-runs/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,5 @@ redirect_from:
2929
- /actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs
3030
- /actions/how-tos/managing-workflow-runs-and-deployments
3131
---
32+
33+
{% data reusables.actions.workflow-run-statuses-2 %}

content/actions/how-tos/manage-workflow-runs/manually-run-a-workflow.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ redirect_from:
1414
- /actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow
1515
---
1616

17+
{% data reusables.actions.workflow-run-statuses-2 %}
18+
1719
{% data reusables.actions.enterprise-github-hosted-runners %}
1820

1921
## Configuring a workflow to run manually

content/actions/how-tos/manage-workflow-runs/re-run-workflows-and-jobs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ versions:
1414
ghec: '*'
1515
---
1616

17+
{% data reusables.actions.workflow-run-statuses-2 %}
18+
1719
> [!NOTE]
1820
> Re-run workflows use the privileges of the actor who initially triggered the workflow, not the privileges of the actor who initiated the re-run. The workflow will also use the same `GITHUB_SHA` (commit SHA) and `GITHUB_REF` (git ref) of the original event that triggered the workflow run.
1921

content/actions/how-tos/manage-workflow-runs/skip-workflow-runs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ redirect_from:
1212
- /actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/skipping-workflow-runs
1313
---
1414

15+
{% data reusables.actions.workflow-run-statuses-2 %}
16+
1517
{% data reusables.actions.enterprise-github-hosted-runners %}
1618

1719
> [!NOTE]

content/rest/actions/workflow-runs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,6 @@ autogenerated: rest
1818

1919
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/managing-workflow-runs).
2020

21+
{% data reusables.actions.workflow-run-statuses-2 %}
22+
2123
<!-- Content after this section is automatically generated -->
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Below are common `status` and `conclusion` values you may see for workflow runs, check runs, and jobs, with an explanation and typical use cases. Use these as a reference when interpreting results returned by the REST and Checks APIs.
2+
3+
4+
**Quick summary:**
5+
- **`status`**: the current lifecycle state of the run or job (for example: `queued`, `in_progress`, `completed`).
6+
- **`conclusion`**: the final outcome when `status` is `completed` (for example: `success`, `failure`, `neutral`, `cancelled`).
7+
8+
**Common `status` values and meaning**
9+
- **`queued`**: The run or job has been scheduled and is waiting for a runner to pick it up (waiting for available runner resources).
10+
- **`requested`**: The run or check run has been requested (for example, by an app or integration) and is awaiting scheduling; it is a precursor to `queued` in some APIs.
11+
- **`waiting`**: The run/job is blocked and waiting on an external gate (for example: a required environment approval, manual intervention, or a required reviewer). This state often indicates human or policy action is needed before the job can proceed.
12+
- **`in_progress`**: The run or job is actively executing on a runner.
13+
- **`completed`**: Execution has finished — look at `conclusion` for the outcome.
14+
15+
**Common `conclusion` values (apply when `status` is `completed`)**
16+
- **`success`**: The run completed successfully.
17+
- **`failure`**: The run failed (one or more failing jobs or checks).
18+
- **`neutral`**: The run completed without a success *or* failure being attributed to it — typically used for informational or non-blocking runs/checks (for example, a lint job that reports results but is configured not to fail the workflow).
19+
- **`cancelled`**: The run was canceled by a user or system action before completion.
20+
- **`skipped`**: The run or job was intentionally skipped (for example, conditionals prevented the job from running).
21+
- **`timed_out`**: The run or job exceeded the allowed time limit and was aborted.
22+
- **`action_required`**: The run finished in a state that requires human action to continue (for example: environment protection rules require approval to proceed or a required review was not completed). This is an actionable state signalling manual intervention is necessary.
23+
- **`stale`**: The run or check is considered out-of-date or no longer relevant (for example, a later commit was pushed that supersedes this run). Behavior may vary by API — often used by the Checks API to indicate a run that no longer applies to the current commit.
24+
25+
State diagram (linear flow, simplified):
26+
27+
`requested` -> `queued` -> `in_progress` -> `completed` -> `conclusion` (one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, `action_required`, `stale`)
28+
29+
Notes on overlapping terms:
30+
- **`pending` vs `queued` vs `requested`**: Different APIs and contexts sometimes use slightly different words for similar queueing states. `requested` is often the earliest state (a run was requested), `queued` means the run is in the runner queue, and `pending` is a generic term used by the Statuses API to mean the result is not yet available. Treat these as queue/pending states that precede `in_progress`.
31+
- **`waiting`**: Typically indicates the run/job is blocked by an external requirement (manual approval, environment protection, required reviewers). A `waiting` state may appear instead of `queued` when the job cannot be scheduled until the blocking condition is resolved.
32+
- **`action_required`**: Although listed as a `conclusion` value in some API responses, this value indicates the run cannot progress or be considered fully successful until a person performs a required action (for example granting an environment approval). Consider it a terminal-but-actionable conclusion.
33+
34+
Usage guidance
35+
- When inspecting a workflow run object from the REST API: check `status` first. If `status` is `completed`, read `conclusion` to determine the final outcome.
36+
- For UI or automation that responds to runs, treat `neutral` as a completed but non-failing outcome and treat `action_required` and `waiting` as requiring human attention before considering a job fully resolved.
37+
- If you need definitive behaviour for a particular webhook or API (for example, whether `stale` should be treated as failure or ignored), consult the specific endpoint docs or test against the API in your environment — some conclusion values are used differently between the Checks API and the Workflow Runs API.
38+
39+
If you'd like, I can produce a more detailed Checks API vs Workflow Runs API appendix or adjust wording for a specific audience.
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
```markdown
2+
Below are common `status` and `conclusion` values you may see for workflow runs, check runs, and jobs, with an explanation and typical use cases. Use these as a reference when interpreting results returned by the REST and Checks APIs.
3+
4+
**Quick summary:**
5+
- **`status`**: the current lifecycle state of the run or job (for example: `queued`, `in_progress`, `completed`).
6+
- **`conclusion`**: the final outcome when `status` is `completed` (for example: `success`, `failure`, `neutral`, `cancelled`).
7+
8+
**Common `status` values and meaning**
9+
- **`queued`**: The run or job has been scheduled and is waiting for a runner to pick it up (waiting for available runner resources).
10+
- **`requested`**: The run or check run has been requested (for example, by an app or integration) and is awaiting scheduling; it is a precursor to `queued` in some APIs.
11+
- **`waiting`**: The run/job is blocked and waiting on an external gate (for example: a required environment approval, manual intervention, or a required reviewer). This state often indicates human or policy action is needed before the job can proceed.
12+
- **`in_progress`**: The run or job is actively executing on a runner.
13+
- **`completed`**: Execution has finished — look at `conclusion` for the outcome.
14+
15+
**Common `conclusion` values (apply when `status` is `completed`)**
16+
- **`success`**: The run completed successfully.
17+
- **`failure`**: The run failed (one or more failing jobs or checks).
18+
- **`neutral`**: The run completed without a success *or* failure being attributed to it — typically used for informational or non-blocking runs/checks (for example, a lint job that reports results but is configured not to fail the workflow).
19+
- **`cancelled`**: The run was canceled by a user or system action before completion.
20+
- **`skipped`**: The run or job was intentionally skipped (for example, conditionals prevented the job from running).
21+
- **`timed_out`**: The run or job exceeded the allowed time limit and was aborted.
22+
- **`action_required`**: The run finished in a state that requires human action to continue (for example: environment protection rules require approval to proceed or a required review was not completed). This is an actionable state signalling manual intervention is necessary.
23+
- **`stale`**: The run or check is considered out-of-date or no longer relevant (for example, a later commit was pushed that supersedes this run). Behavior may vary by API — often used by the Checks API to indicate a run that no longer applies to the current commit.
24+
25+
State diagram (linear flow, simplified):
26+
27+
`requested` -> `queued` -> `in_progress` -> `completed` -> `conclusion` (one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, `action_required`, `stale`)
28+
29+
Notes on overlapping terms:
30+
- **`pending` vs `queued` vs `requested`**: Different APIs and contexts sometimes use slightly different words for similar queueing states. `requested` is often the earliest state (a run was requested), `queued` means the run is in the runner queue, and `pending` is a generic term used by the Statuses API to mean the result is not yet available. Treat these as queue/pending states that precede `in_progress`.
31+
- **`waiting`**: Typically indicates the run/job is blocked by an external requirement (manual approval, environment protection, required reviewers). A `waiting` state may appear instead of `queued` when the job cannot be scheduled until the blocking condition is resolved.
32+
- **`action_required`**: Although listed as a `conclusion` value in some API responses, this value indicates the run cannot progress or be considered fully successful until a person performs a required action (for example granting an environment approval). Consider it a terminal-but-actionable conclusion.
33+
34+
Usage guidance
35+
- When inspecting a workflow run object from the REST API: check `status` first. If `status` is `completed`, read `conclusion` to determine the final outcome.
36+
- For UI or automation that responds to runs, treat `neutral` as a completed but non-failing outcome and treat `action_required` and `waiting` as requiring human attention before considering a job fully resolved.
37+
- If you need definitive behaviour for a particular webhook or API (for example, whether `stale` should be treated as failure or ignored), consult the specific endpoint docs or test against the API in your environment — some conclusion values are used differently between the Checks API and the Workflow Runs API.
38+
39+
If you'd like, I can also add a small diagram image or a more detailed job-by-job mapping for the Checks API vs Workflow Runs API.
40+
```

0 commit comments

Comments
 (0)