docs: fix github webhook example fields#1119
Conversation
Greptile SummaryThis docs-only PR fixes two incorrect fields in the GitHub webhook
Confidence Score: 5/5Documentation-only changes that bring examples into alignment with the actual API schema; no code paths are affected. Both changed fields ( No files require special attention.
|
| Filename | Overview |
|---|---|
| docs/integration.md | Replaces deprecated bodyContains with bodyPattern in the GitHub Webhook YAML example and in the filtering options prose description; both changes align with the API type definition. |
| examples/10-taskspawner-github-webhook/taskspawner.yaml | Fixes two issues: replaces deprecated bodyContains with bodyPattern in the issue-comment filter, and corrects the Workspace spec.repo field from an invalid object form to the string schema the API actually requires. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[GitHub Webhook Event] --> B{githubWebhook filter}
B -->|event: issue_comment\naction: created\nbodyPattern: /kelos| C[Filter matches]
B -->|no match| D[Event ignored]
C --> E[TaskSpawner creates Task]
E --> F[Agent Pod runs]
F --> G[Workspace cloned\nspec.repo: string URL]
G --> H[Optional secretRef\nat spec level]
Comments Outside Diff (1)
-
self-development/kelos-workers.yaml, line 48 (link)Deprecated
bodyContainsstill present in self-development configsThis PR removes
bodyContainsfrom the user-facing example and integration docs, but the self-development directory still usesbodyContainsextensively —kelos-workers.yaml,kelos-squash-commits.yaml,kelos-reviewer.yaml,kelos-pr-responder.yaml,kelos-planner.yaml,kelos-api-reviewer.yaml, andself-development/README.mdall reference it. While the deprecated field continues to work today, leaving these files out of sync with the current docs can confuse contributors who use the self-development configs as secondary examples and then compare them againstintegration.md.Prompt To Fix With AI
This is a comment left during a code review. Path: self-development/kelos-workers.yaml Line: 48 Comment: **Deprecated `bodyContains` still present in self-development configs** This PR removes `bodyContains` from the user-facing example and integration docs, but the self-development directory still uses `bodyContains` extensively — `kelos-workers.yaml`, `kelos-squash-commits.yaml`, `kelos-reviewer.yaml`, `kelos-pr-responder.yaml`, `kelos-planner.yaml`, `kelos-api-reviewer.yaml`, and `self-development/README.md` all reference it. While the deprecated field continues to work today, leaving these files out of sync with the current docs can confuse contributors who use the self-development configs as secondary examples and then compare them against `integration.md`. How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 1
self-development/kelos-workers.yaml:48
**Deprecated `bodyContains` still present in self-development configs**
This PR removes `bodyContains` from the user-facing example and integration docs, but the self-development directory still uses `bodyContains` extensively — `kelos-workers.yaml`, `kelos-squash-commits.yaml`, `kelos-reviewer.yaml`, `kelos-pr-responder.yaml`, `kelos-planner.yaml`, `kelos-api-reviewer.yaml`, and `self-development/README.md` all reference it. While the deprecated field continues to work today, leaving these files out of sync with the current docs can confuse contributors who use the self-development configs as secondary examples and then compare them against `integration.md`.
Reviews (1): Last reviewed commit: "docs: fix github webhook example fields" | Re-trigger Greptile
The bodyContains filter field is deprecated in favour of bodyPattern, which supports the same plain-text substring semantics for these literal command strings while also enabling regex-based filters. PR #1119 added the user-facing migration in docs/ and examples/ but explicitly left self-development/ out of scope; the kelos-bot reviewer flagged the remaining bodyContains uses as P2 outside-diff because the self-development files are read by contributors as secondary examples. This also exercises the "sweep self-development/ when deprecating fields" convention added to AGENTS.md in the previous commit. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
f8d6e6e to
574e2a0
Compare
What type of PR is this?
/kind docs
What this PR does / why we need it:
Fixes the GitHub webhook TaskSpawner example so new users do not copy invalid or deprecated fields:
spec.repofrom object form to the string schema used by the APIbodyContainsusage withbodyPatternin example 10 and the integration docs filtering listWhich issue(s) this PR is related to:
Fixes #1118
Special notes for your reviewer:
Orbit assessment: simple -> hunter. This is a docs/example-only fix.
Validation run:
git diff --checkexamples/10-taskspawner-github-webhook/taskspawner.yamlbodyContainsno longer appears in the issue target filesDoes this PR introduce a user-facing change?
Summary by cubic
Fix GitHub webhook TaskSpawner docs/example to the current schema. Replace
bodyContainswithbodyPattern, use stringspec.repo, and update comment to say “matching”.Written for commit 574e2a0. Summary will update on new commits. Review in cubic