Skip to content

Commit bcdeef3

Browse files
gjkim42claude
andcommitted
Add deploy-dev sync, controller migration, and release note conventions
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent c8451fe commit bcdeef3

2 files changed

Lines changed: 5 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
- **Consistent guidance across surfaces.** When changing user-facing guidance or instructions, search for all surfaces that reference the same topic (docs, CLI output, templates, code comments) and update them together.
1212
- **Provider-agnostic API design.** When adding CRD fields or API types, prefer generic, provider-agnostic abstractions over provider-specific ones (e.g., a generic `none` credential type instead of `bedrock`). Provider-specific details should be handled through existing generic mechanisms like `PodOverrides.Env` rather than dedicated fields.
1313
- **Idiomatic Helm values.** Use nested dictionary structures in `values.yaml` (e.g., `controller.resources.requests.cpu`) instead of flat string-based parameters. Values that represent structured data should be proper YAML dictionaries, not strings.
14+
- **Deploy-dev workflow sync.** When adding new controller flags, resource settings, or monitoring config, update `.github/workflows/deploy-dev.yaml` to pass the corresponding values.
15+
- **Controller-driven migration.** When introducing breaking changes to deployed resources (e.g., label selector changes), prefer automated migration in the controller over requiring manual user intervention. Add a FIXME comment noting when the migration code can be removed.
1416

1517
## Key Makefile Targets
1618
- `make verify` — run all verification checks (lint, fmt, vet, etc.).
@@ -27,7 +29,7 @@
2729
- Choose exactly one `/kind` label from: `bug`, `cleanup`, `docs`, `feature`.
2830
- If there is no associated issue, write "N/A" under the issue section.
2931
- If the PR does not introduce a user-facing change, write "NONE" in the `release-note` block.
30-
- If the PR introduces a new API field, CRD change, or user-facing feature, write a meaningful release note describing the change — do not write "NONE".
32+
- If the PR introduces a new API field, CRD change, or user-facing feature, write a meaningful release note describing the change — do not write "NONE". If the change affects existing deployments (e.g., selector changes, breaking migrations), the release note must describe the required user action.
3133
- PRs that only modify files under `self-development/` are internal agent improvements — use `/kind cleanup` and write "NONE" in the `release-note` block.
3234

3335
## Directory Structure

self-development/agentconfig.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,5 @@ spec:
3434
- Kubernetes resource comparison: use semantic `.Equal()` or `.Cmp()` methods for `resource.Quantity` comparisons, not `reflect.DeepEqual`
3535
- Provider-agnostic API design: when adding CRD fields or API types, prefer generic abstractions over provider-specific ones (e.g., `none` credential type instead of `bedrock`); use existing generic mechanisms like `PodOverrides.Env` for provider-specific details
3636
- Idiomatic Helm values: use nested dictionary structures in `values.yaml` (e.g., `controller.resources.requests.cpu`) instead of flat string-based parameters; structured data should be proper YAML dictionaries, not strings
37+
- Deploy-dev workflow sync: when adding new controller flags, resource settings, or monitoring config, update `.github/workflows/deploy-dev.yaml` to pass the corresponding values
38+
- Controller-driven migration: when introducing breaking changes to deployed resources (e.g., label selector changes), prefer automated migration in the controller over requiring manual user intervention; add a FIXME comment noting when the migration code can be removed

0 commit comments

Comments
 (0)