CheckRun
objectA check performed on the code of a given code change
The id of the check.
Example:21
The SHA of the commit that is being checked.
Example:009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
Example:MDg6Q2hlY2tSdW40
Example:42
Example:https://api.github.com/repos/github/hello-world/check-runs/4
Example:https://github.com/github/hello-world/runs/4
Example:https://example.com
The phase of the lifecycle that the check is currently in.
Allowed values:queuedin_progresscompleted
Example:queued
Allowed values:successfailureneutralcancelledskippedtimed_outaction_required
Example:neutral
Example:2018-05-04T01:14:52Z
Example:2018-05-04T01:14:52Z
Show Child Parameters
The name of the check.
Example:test-coverage
Show Child Parameters
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
Show Child Parameters
Show Child Parameters
A deployment created as the result of an Actions check run from a workflow that references an environment
Show Child Parameters
Check Annotation
objectCheck Annotation
Example:README.md
Example:2
Example:2
Example:5
Example:10
Example:warning
Example:Spell Checker
Example:Check your spelling for 'banaas'.
Example:Do you mean 'bananas' or 'banana'?
Simple Commit
objectSimple Commit
Show Child Parameters
Show Child Parameters
CheckSuite
objectA suite of checks performed on the code of a given code change
Example:5
Example:MDEwOkNoZWNrU3VpdGU1
Example:master
The SHA of the head commit that is being checked.
Example:009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
Allowed values:queuedin_progresscompleted
Example:completed
Allowed values:successfailureneutralcancelledskippedtimed_outaction_required
Example:neutral
Example:https://api.github.com/repos/github/hello-world/check-suites/5
Example:146e867f55c26428e5f9fade55a9bbf5e95a7912
Example:d6fde92930d4715a2b49857d24b940956b26d2d3
Show Child Parameters
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
Show Child Parameters
Minimal Repository
Show Child Parameters
Simple Commit
Show Child Parameters
Check Suite Preference
objectCheck suite configuration preferences for a repository.
Show Child Parameters
Minimal Repository