Add API contract validation example (example 12)#974
Open
kelos-bot[bot] wants to merge 2 commits intomainfrom
Open
Add API contract validation example (example 12)#974kelos-bot[bot] wants to merge 2 commits intomainfrom
kelos-bot[bot] wants to merge 2 commits intomainfrom
Conversation
There was a problem hiding this comment.
2 issues found across 9 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="examples/12-api-contract-validation/taskspawner-cron.yaml">
<violation number="1" location="examples/12-api-contract-validation/taskspawner-cron.yaml:27">
P2: Include `*.json` in the diff command; the current command skips JSON OpenAPI files despite the stated scope.</violation>
</file>
<file name="examples/12-api-contract-validation/taskspawner-webhook.yaml">
<violation number="1" location="examples/12-api-contract-validation/taskspawner-webhook.yaml:35">
P2: Remove the manual PR branch checkout instruction; Kelos already handles PR branch checkout automatically.
(Based on your team's feedback about avoiding manual git checkout steps in Kelos prompts.) [FEEDBACK_USED]</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
Add a new example demonstrating an end-to-end API contract validation pipeline using current Kelos primitives. Includes: - PR-triggered validation via /validate-api comment (webhook TaskSpawner) - Weekly cross-service compatibility audit (cron TaskSpawner) - Consumer update pipeline with dependsOn task chaining - AgentConfig with API validation specialist instructions Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Include *.json in the cron audit git diff command to cover JSON OpenAPI files - Remove manual PR branch checkout instruction since Kelos handles this automatically Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
43120f7 to
1a41397
Compare
kelos-bot Bot
pushed a commit
that referenced
this pull request
Apr 14, 2026
…eedback Adds conventions learned from recent PR reviews: 1. Fail fast on invalid configuration (PR #971): three P1 and four P2 issues flagged silent degradation when credentials or config were invalid, falling back to unauthenticated requests instead of erroring. 2. No manual PR branch checkout in TaskSpawner prompts (PR #974): Kelos already checks out the PR branch automatically; manual checkout instructions are redundant and confusing. Also carries forward the previously proposed changes from PR #786: - os.Getenv() secret-in-flag-defaults convention (PR #971) - TaskSpawner creation conventions (PR #965) - Branch template variable documentation fix (PR #965) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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 type of PR is this?
/kind docs
What this PR does / why we need it:
Adds a new example (
examples/12-api-contract-validation/) demonstrating an end-to-end API contract validation pipeline using current Kelos primitives. The example includes:/validate-apicomments on PRs, runs structural diff tools, classifies changes (non-breaking/potentially breaking/breaking), and posts review findings.dependsOnthat identifies affected consumers and generates migration guides when intentional breaking changes are approved.Also updates the examples README index with the new entry.
Which issue(s) this PR is related to:
Fixes #972
Special notes for your reviewer:
This is a documentation-only PR — all files are YAML configs, Markdown, or Kubernetes Secret templates. No Go code changes. The YAML files pass
yamlfmt -lintformatting checks.The configurations use existing Kelos API primitives (
githubWebhook,cron,dependsOn,AgentConfig,bodyContains). The README notes complementary issues (#778, #884, #842, #881) that would enhance the workflow.Does this PR introduce a user-facing change?
Summary by cubic
Adds example 12: an end-to-end API contract validation pipeline with PR-triggered checks, a weekly audit, and a consumer migration flow. Improves coverage for JSON OpenAPI files and simplifies setup.
New Features
examples/12-api-contract-validation/with README and manifests/validate-apiPR comments and posts validation resultsidentify-consumers→generate-migration-guide) usingdependsOnAgentConfigwith tool guidance (oasdiff,buf,graphql-inspector,gh); includes secrets and workspace templates, plus examples index updateRefinements
*.jsonto cover JSON OpenAPI specsWritten for commit 1a41397. Summary will update on new commits.