Repository navigation
Document how to read Chainguard Checks results with the GitHub API - #4268
Merged
Merged
Conversation
Add a "Read results with the GitHub API" section to the Checks on GitHub page for merge bots, dashboards, and agents. It covers the GitHub access the API needs, how to read the summary check on a pull request's head commit, when a result goes out of date, how each check's outcome maps to its check run's conclusion, and why only the summary check decides whether a pull request passes. The page's intro now mentions the section. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
matthewhelmke
approved these changes
Oct 20, 2026
matthewhelmke
left a comment
Collaborator
There was a problem hiding this comment.
This is clear to me and fills a gap nicely. Thank you!!
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
This PR adds a Read results with the GitHub API section to
content/chainguard/checks/github.mdand mentions it in the page's intro. The section covers:limited_ownerrole in a Starter organization.ci/run:label, a change to the pull request, or a push.Why
Merge bots, dashboards, and agents read Chainguard Checks results through GitHub's REST API. The page didn't say where results appear, which conclusion to act on, or which per-check results can be missing or out of date.
How it was checked
null, as the page says.markdownlint-cli2on the page. Both pass.For reviewers
The section tells a merge bot to find the summary check by name. Another app or a workflow job could create a check run with the same name. The section doesn't yet say how to confirm which app created a check run, because the app's identity isn't a stable contract yet. That guidance waits for engineering to confirm.
🤖 Generated with Claude Code