docs: Document reporting.checks for GitHub Check Runs#1129
Merged
Conversation
Add reference.md rows for spec.when.githubPullRequests.reporting.checks.name
and spec.when.githubWebhook.reporting.{enabled,checks.name}, noting the
checks:write permission requirement and the CEL constraints (rejected on
githubIssues; requires a PR event type on githubWebhook).
Extend integration.md with a branch protection / merge queue walkthrough
in the GitHub Pull Requests section and a status reporting note in the
GitHub Webhooks section.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
github-actions
Bot
added
needs-triage
needs-kind
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
kelos-bot[bot] has reached the 50-review limit for trial accounts. To continue receiving code reviews, upgrade your plan.
github-actions
Bot
added
needs-actor
release-note-none
kind/docs
and removed
needs-kind
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
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
1 participant
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 type of PR is this?
/kind docs
What this PR does / why we need it:
The
reporting.checkssub-field ofGitHubReportingis fully implemented but undocumented indocs/reference.mdanddocs/integration.md. New users wanting to make a Kelos agent run a required status check for branch protection have no way to discover the feature.This PR adds:
docs/reference.md: three new rowsspec.when.githubPullRequests.reporting.checks.namespec.when.githubWebhook.reporting.enabledspec.when.githubWebhook.reporting.checks.nameEach row notes the
checks:writepermission requirement, the default name (Kelos: <taskspawner-name>), and the relevant CEL constraints (rejected ongithubIssues; webhook source requires at least one ofpull_request,pull_request_review,pull_request_review_comment,pull_request_target).docs/integration.md: a status reporting block in the GitHub Pull Requests section with a YAML example, branch protection walkthrough, and a cross-reference to the webhook source. A short status reporting paragraph is also added to the GitHub Webhooks section.Which issue(s) this PR is related to:
Fixes #1123
Special notes for your reviewer:
Docs-only change; no API or behavior modifications.
make verifypasses.Does this PR introduce a user-facing change?
Summary by cubic
Documented
reporting.checksfor GitHub PRs and webhooks so Kelos tasks can create Check Runs used by branch protection and merge queues. Adds reference rows and an integration example (YAML), and notes thechecks:writepermission and CEL validation rules; fixes #1123.Written for commit 7f7bb9b. Summary will update on new commits.