Skip to content

Commit d40dcf9

Browse files
thyeggmanCopilotheiskrsubatoi
authored
Add tables describing check statuses and conclusions (#53881)
Co-authored-by: Copilot <[email protected]> Co-authored-by: Kevin Heis <[email protected]> Co-authored-by: Ben Ahmady <[email protected]>
1 parent a8a29c8 commit d40dcf9

File tree

3 files changed

+31
-4
lines changed

3 files changed

+31
-4
lines changed

content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ You can navigate between the checks summaries for various commits in a pull requ
5353

5454
![Screenshot of the "Checks" tab of a pull request. The "Checks" tab and the dropdown menu to select a commit are both outlined in dark orange.](/assets/images/help/pull_requests/checks-summary-for-various-commits.png)
5555

56-
### Skipping and requesting checks for individual commits
56+
## Skipping and requesting checks for individual commits
5757

5858
When a repository is set to automatically request checks for pushes, you can choose to skip checks for an individual commit you push. When a repository is _not_ set to automatically request checks for pushes, you can request checks for an individual commit you push. For more information on these settings, see [AUTOTITLE](/rest/checks/suites#update-repository-preferences-for-check-suites).
5959

@@ -81,6 +81,33 @@ Alternatively, to skip or request _all_ checks for your commit, add one of the f
8181

8282
{% data reusables.commits.about-commit-cleanup %}
8383

84-
### Retention of checks
84+
## Check statuses and conclusions
85+
86+
Checks can have many different statuses. Statuses describe the state of a check from when it is created to when it is completed. Some statuses cannot be set manually and are reserved for {% data variables.product.prodname_actions %}. When a check has a status of `completed`, it has a conclusion. The conclusion describes the result of the check. All possible check statuses and conclusions are listed below.
87+
88+
| Status | Description | {% data variables.product.prodname_actions %} only? |
89+
| --- | --- | --- |
90+
| `completed` | The check run completed and has a conclusion (see below). | No |
91+
| `expected` | The check run is waiting for a status to be reported. | Yes |
92+
| `failure` | The check run failed. | No |
93+
| `in_progress` | The check run is in progress. | No |
94+
| `pending` | The check run is at the front of the queue but the [group-based concurrency](/actions/writing-workflows/choosing-what-your-workflow-does/control-the-concurrency-of-workflows-and-jobs) limit has been reached. | Yes |
95+
| `queued` | The check run has been queued. | No |
96+
| `requested` | The check run has been created but has not been queued. | Yes |
97+
| `startup_failure` | The check suite failed during startup. This status is not applicable to check runs. | Yes |
98+
| `waiting` | The check run is waiting for a [deployment protection rule](/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment#deployment-protection-rules) to be satisfied. | Yes |
99+
100+
| Conclusion | Description |
101+
| --- | --- |
102+
| `action_required` | The check run provided required actions upon its completion. For more information, see [AUTOTITLE](/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions). |
103+
| `cancelled` | The check run was cancelled before it completed. |
104+
| `failure` | The check run failed. |
105+
| `neutral` | The check run completed with a neutral result. This is treated as a success for dependent checks in {% data variables.product.prodname_actions %}. |
106+
| `skipped` | The check run was skipped. This is treated as a success for dependent checks in {% data variables.product.prodname_actions %}. |
107+
| `stale` | The check run was marked stale by {% data variables.product.github %} because it took too long. |
108+
| `success` | The check run completed successfully. |
109+
| `timed_out` | The check run timed out. |
110+
111+
## Retention of checks
85112

86113
{% data reusables.pull_requests.retention-checks-data %}

content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/troubleshooting-required-status-checks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ remote: error: Required status check "ci-build" is failing
3636
3737
## Required check needs to succeed against the latest commit SHA
3838

39-
In order for a pull request to be merged, all required checks must pass against the latest commit SHA. This ensures that the most recent changes are validated and meet the required standards before merging. Checks that were triggered using a previous commit SHA will not be used as part of required checks.
39+
In order for a pull request to be merged, all required checks must pass against the latest commit SHA. This ensures that the most recent changes are validated and meet the required standards before merging. Checks that were triggered using a previous commit SHA will not be used as part of required checks. Successful check statuses are: `success`, `skipped`, and `neutral`. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).
4040

4141
## Conflicts between head commit and test merge commit
4242

content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ For complex pull requests that require many reviews, requiring an approval from
9595

9696
### Require status checks before merging
9797

98-
Required status checks ensure that all required CI tests are either passing or skipped before collaborators can make changes to a protected branch. Required status checks can be checks or statuses. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).
98+
Required status checks must have a `successful`, `skipped`, or `neutral` status before collaborators can make changes to a protected branch. Required status checks can be checks or commit statuses. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).
9999

100100
You can use the commit status API to allow external services to mark commits with an appropriate status. For more information, see [AUTOTITLE](/rest/commits/statuses).
101101

0 commit comments

Comments
 (0)