Add more information about status checks (#49464)
This commit is contained in:
@@ -31,19 +31,25 @@ You can see the overall state of the last commit to a branch on your repository'
|
||||
There are two types of status checks on {% data variables.product.product_name %}:
|
||||
|
||||
- Checks
|
||||
- Statuses
|
||||
- Commit statuses
|
||||
|
||||
_Checks_ are different from _statuses_ in that they provide line annotations, more detailed messaging, and are only available for use with {% data variables.product.prodname_github_apps %}.
|
||||
|
||||
Organization owners and users with push access to a repository can create checks and statuses with {% data variables.product.product_name %}'s API. For more information, see "[AUTOTITLE](/rest/checks)" and "[AUTOTITLE](/rest/commits#commit-statuses)."
|
||||
|
||||
## Checks
|
||||
|
||||
When _checks_ are set up in a repository, pull requests have a **Checks** tab where you can view detailed build output from status checks and rerun failed checks.
|
||||
_Checks_ are different from _commit statuses_ in that they provide line annotations, more detailed messaging, and are only available for use with {% data variables.product.prodname_github_apps %}.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** The **Checks** tab only gets populated for pull requests if you set up _checks_, not _statuses_, for the repository.
|
||||
**Note:** {% data variables.product.prodname_actions %} generates checks, not commit statuses, when workflows are run.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
Organization owners and users with push access to a repository can create checks and commit statuses with {% data variables.product.product_name %}'s API. For more information, see "[AUTOTITLE](/rest/checks)" and "[AUTOTITLE](/rest/commits/statuses)."
|
||||
|
||||
## Checks
|
||||
|
||||
When _checks_ are set up in a repository, pull requests have a **Checks** tab where you can view detailed build output from checks and rerun failed checks.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** The **Checks** tab only gets populated for pull requests if you set up _checks_, not _commit statuses_, for the repository.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
@@ -83,7 +89,7 @@ Alternatively, to skip or request _all_ checks for your commit, add one of the f
|
||||
|
||||
{% ifversion status-check-retention %}
|
||||
|
||||
### Retention of status checks
|
||||
### Retention of checks
|
||||
|
||||
{% data reusables.pull_requests.retention-checks-data %}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user