Exploring annotations within checks
From the previous chapter, where we went over the Checks API, you might have recalled us mentioning that annotations are a sibling to the conclusion field. Annotations, which are often considered concise notes, are your direct line of communication to the code committer against your code base. Imagine providing actionable feedback, context-rich guidance, and real-time insights right where they matter most—within the code itself. In this section, we’ll uncover the powerful synergy between checks and annotations, where code review transforms into a collaborative and insightful experience.
You can create annotations while creating the check run or as another call to the annotations endpoint under a given check run ID. Let’s dive into the structure of annotations and the rules of creating them.
The structure of an annotation
When creating annotations through the REST API, you enrich your code base with contextual feedback...
