diff --git a/content/apps/creating-github-apps/guides/creating-ci-tests-with-the-checks-api.md b/content/apps/creating-github-apps/guides/creating-ci-tests-with-the-checks-api.md index 9eaace4071..57b2cb6536 100644 --- a/content/apps/creating-github-apps/guides/creating-ci-tests-with-the-checks-api.md +++ b/content/apps/creating-github-apps/guides/creating-ci-tests-with-the-checks-api.md @@ -235,7 +235,7 @@ The code above calls the "[AUTOTITLE](/rest/checks#update-a-check-run)" API endp Here's what this code is doing. First, it updates the check run's status to `in_progress` and implicitly sets the `started_at` time to the current time. In [Part 2](#part-2-creating-the-octo-rubocop-ci-test) of this quickstart, you'll add code that kicks off a real CI test under `***** RUN A CI TEST *****`. For now, you'll leave that section as a placeholder, so the code that follows it will just simulate that the CI process succeeds and all tests pass. Finally, the code updates the status of the check run again to `completed`. -You'll notice in the "[AUTOTITLE](/rest/checks#update-a-check-run)" docs that when you provide a status of `completed`, the `conclusion` and `completed_at` parameters are required. The `conclusion` summarizes the outcome of a check run and can be `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. You'll set the conclusion to `success`, the `completed_at` time to the current time, and the status to `completed`. +You'll notice in the "[AUTOTITLE](/rest/checks#update-a-check-run)" docs that when you provide a status of `completed`, the `conclusion` and `completed_at` parameters are required. The `conclusion` summarizes the outcome of a check run and can be `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `skipped`, or `action_required`. You'll set the conclusion to `success`, the `completed_at` time to the current time, and the status to `completed`. You could also provide more details about what your check is doing, but you'll get to that in the next section. Let's test this code again by re-running `template_server.rb`: diff --git a/content/rest/guides/using-the-rest-api-to-interact-with-checks.md b/content/rest/guides/using-the-rest-api-to-interact-with-checks.md index 4e05309baf..5398bec212 100644 --- a/content/rest/guides/using-the-rest-api-to-interact-with-checks.md +++ b/content/rest/guides/using-the-rest-api-to-interact-with-checks.md @@ -23,14 +23,17 @@ For an example of how to use the REST API with a {% data variables.product.prodn When someone pushes code to a repository, GitHub creates a check suite for the last commit. A check suite is a collection of the [check runs](/rest/checks#check-runs) created by a single GitHub App for a specific commit. Check suites summarize the status and conclusion of the check runs that a suite includes. -The `status` can be `queued`, `in_progress`, or `complete`. +The `status` can be `queued`, `in_progress`, or `completed`. -If the status is `complete`, the conclusion can be any of the following: +If the status is `completed`, the conclusion can be any of the following: - `action_required` - `cancelled` - `timed_out` - `failure` - `neutral` +- `skipped` +- `stale` +- `startup_failure` - `success` The check suite reports the highest priority check run `conclusion` in the check suite's `conclusion`. For example, if three check runs have conclusions of `timed_out`, `success`, and `neutral` the check suite conclusion will be `timed_out`. @@ -49,7 +52,7 @@ To use the endpoints to manage check suites, the {% data variables.product.prodn A check run is an individual test that is part of a check suite. Each run includes a status and conclusion. -The status can be `queued`, `in_progress`, or `complete`. +The status can be `queued`, `in_progress`, or `completed`. If the status is `completed`, the conclusion can be any of the following: - `action_required` @@ -57,6 +60,7 @@ If the status is `completed`, the conclusion can be any of the following: - `timed_out` - `failure` - `neutral` +- `skipped` - `success` If a check run is in an incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Only {% data variables.product.prodname_dotcom %} can mark check runs as `stale`. For more information about possible conclusions of a check run, see the [`conclusion` parameter](/rest/checks#create-a-check-run--parameters).