Status Check Policy
objectStatus Check Policy
Example:https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
Example:true
Example:continuous-integration/travis-ci
Example:https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts
Protected Branch
objectBranch protections protect branches
Status Check Policy
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Branch Restriction Policy
Show Child Parameters
Show Child Parameters
Deployment
objectA deployment created as the result of an Actions check run from a workflow that references an environment
Example:https://api.github.com/repos/octocat/example/deployments/1
Unique identifier of the deployment
Example:42
Example:MDEwOkRlcGxveW1lbnQx
Parameter to specify a task to execute
Example:deploy
Example:staging
Name for the target deployment environment.
Example:production
Example:Deploy request from hubot
Example:2012-07-20T01:19:13Z
Example:2012-07-20T01:19:13Z
Example:https://api.github.com/repos/octocat/example/deployments/1/statuses
Example:https://api.github.com/repos/octocat/example
Specifies if the given environment is will no longer exist at some point in the future. Default: false.
Example:true
Specifies if the given environment is one that end-users directly interact with. Default: false.
Example:true
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
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'?