Send detailed information about the checks your integrations run with the Checks API. Rather than binary pass/fail build statuses, integrations can report rich statuses, annotate lines of code with detailed information, and kick off reruns. The Checks API functionality is available exclusively to your GitHub Apps.
Code with context
Produce sophisticated feedback so developers can understand the impact of their code
Leverage detailed information for CI, linting, and acceptance testing
Provide context for developers within pull requests in the new Checks tab
Integrations built with Checks API
Ship higher-quality iOS, Android, Windows, and macOS apps faster. Connect your repository, and within minutes, build in the cloud, test on real devices, distribute to beta testers and app stores, and view the results of checks right from GitHub.
Get a complete picture of a project’s health directly from GitHub by viewing your build’s stages, jobs, and results, including the config associated with them. You can also re-run builds from within the GitHub interface.
Create fast, consistent, reliable builds across all languages. Automatically build containers or non-container artifacts on commits to your GitHub repository. Get complete control over defining custom workflows for building, testing, and deploying.
For an example of how to use the Checks API with a GitHub App, see "Creating CI tests with the Checks API."
The check runs API enables you to build GitHub Apps that run powerful checks against code changes in a repository. You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits.
A check suite is a collection of the 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.
Triggered when a check run is
completed, or has a
Triggered when a check suite is