Working with Checks

This chapter covers check suites, check runs, and commit status and will equip you with the knowledge and skills to create and leverage them effectively. You’ll learn how to create them from within workflows and from a custom action and be able to take this knowledge into future chapters to create unique workflow experiences.

In our journey, we’ll first explore what check suites and check runs are and understand how they can provide valuable insights into the status of your build. You’ll discover how to create custom check runs and check suites tailored to your specific needs, enabling you to better inform developers about the progress and outcomes of their workflows. Commit statuses will be explored to understand the opportunities to reference external systems for results held within those platforms. We will learn how to use the GitHub API to create checks and commit statuses to create various commit health checks within our ecosystem.