docs/data/reusables/webhooks/check_run_properties.md at ef41ed03032e948c65cff3b60e9ebcfa67d7bbec

mirror of synced 2026-01-05 12:07:35 -05:00

Files

Soe Tun b34588556f Clarify check_suite relation to its parent pull_request (#26432 )

- pull_request is more dynamic in its life-cycle than check_suite as
  subsequent git pushes are made
- ∴ the PR's latest head_sha may not match the check_suite's head_sha

Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
Co-authored-by: Grace Park <gracepark@github.com>

2022-03-29 18:54:33 +00:00

2.6 KiB

Raw Blame History

Key	Type	Description
`action`	`string`	The action performed. Can be one of: `created` - A new check run was created. `completed` - The `status` of the check run is `completed`. `rerequested` - Someone requested to re-run your check run from the pull request UI. See "About status checks" for more details about the GitHub UI. When you receive a `rerequested` action, you'll need to create a new check run. Only the {% data variables.product.prodname_github_app %} that someone requests to re-run the check will receive the `rerequested` payload. `requested_action` - Someone requested an action your app provides to be taken. Only the {% data variables.product.prodname_github_app %} someone requests to perform an action will receive the `requested_action` payload. To learn more about check runs and requested actions, see "Check runs and requested actions."
`check_run`	`object`	The check_run.
`check_run[status]`	`string`	The current status of the check run. Can be `queued`, `in_progress`, or `completed`.
`check_run[conclusion]`	`string`	The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, {% ifversion fpt or ghes or ghae or ghec %}`action_required` or `stale`{% else %}or `action_required`{% endif %}. This value will be `null` until the check run has `completed`.
`check_run[name]`	`string`	The name of the check run.
`check_run[check_suite][id]`	`integer`	The id of the check suite that this check run is part of.
`check_run[check_suite][pull_requests]`	`array`	An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`. Note: The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.
`check_run[check_suite][deployment]`	`object`	A deployment to a repository environment. This will only be populated if the check run was created by a {% data variables.product.prodname_actions %} workflow job that references an environment.
`requested_action`	`object`	The action requested by the user.
`requested_action[identifier]`	`string`	The integrator reference of the action requested by the user.

2.6 KiB Raw Blame History

2.6 KiB

Raw Blame History