Skip to content

Add CRD design, API compatibility, and Helm gating conventions#786

Open
kelos-bot[bot] wants to merge 1 commit intomainfrom
kelos-config-update-latest
Open

Add CRD design, API compatibility, and Helm gating conventions#786
kelos-bot[bot] wants to merge 1 commit intomainfrom
kelos-config-update-latest

Conversation

@kelos-bot
Copy link
Copy Markdown

@kelos-bot kelos-bot bot commented Mar 24, 2026

/kind cleanup

What this PR does / why we need it:

Adds agent conventions derived from recent PR review feedback, applied consistently across CLAUDE.md/AGENTS.md and self-development/agentconfig.yaml.

New conventions (from this week's reviews):

  1. Per-TaskSpawner configuration in CRD fields — Configuration that varies per TaskSpawner should be a CRD field, not a controller-level flag. Controller flags are for global settings only.
  2. CRD API backward compatibility — Never rename or remove existing CRD JSON field tags, as this silently breaks existing manifests.
  3. Gate optional CRDs behind Helm values — Helm templates referencing non-core CRDs (e.g., PodMonitoring) must be gated behind a values flag so installs don't fail on clusters without those CRDs.

Carried forward conventions (from prior reviews):

  1. Consistent guidance across surfaces — Update all surfaces referencing the same topic together.
  2. Provider-agnostic API design — Prefer generic abstractions over provider-specific CRD fields.
  3. Idiomatic Helm values — Use nested dictionary structures, not flat string-based parameters.
  4. Deploy-dev workflow sync — Update deploy-dev.yaml when adding controller flags or monitoring config.
  5. Controller-driven migration — Prefer automated migration over manual user intervention for breaking changes.
  6. Release note user actions — Release notes must describe required user actions for breaking changes.

Evidence from PR reviews:

Which issue(s) this PR is related to:

N/A

Special notes for your reviewer:

This PR replaces the previous content on this branch. All conventions are backed by specific PR review evidence listed above.

Does this PR introduce a user-facing change?

NONE

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 4 files

@kelos-bot kelos-bot bot changed the title Add pre-push verification and cross-surface update conventions Add deploy-dev sync, controller migration, and release note conventions Mar 28, 2026
Add three new agent conventions from recent PR review feedback:

1. Per-TaskSpawner configuration should be CRD fields, not controller
   flags (PR #838 - gjkim42 review)
2. CRD API backward compatibility - never rename JSON field tags
   (PR #838 - P1 review finding)
3. Gate optional CRDs behind Helm values flags (PR #821 - PodMonitoring
   broke installs on clusters without monitoring.googleapis.com)

Also includes previously proposed conventions from PR #786:
- Consistent guidance across surfaces
- Provider-agnostic API design
- Idiomatic Helm values
- Deploy-dev workflow sync
- Controller-driven migration
- Release note user action requirements

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@kelos-bot kelos-bot bot force-pushed the kelos-config-update-latest branch from bcdeef3 to 7ade17e Compare March 29, 2026 18:06
@kelos-bot kelos-bot bot changed the title Add deploy-dev sync, controller migration, and release note conventions Add CRD design, API compatibility, and Helm gating conventions Mar 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant