chore: wire .github/instructions to AGENTS chain; add secret-block and constraints-warning rules#6461
Open
bkenez wants to merge 2 commits into
Open
chore: wire .github/instructions to AGENTS chain; add secret-block and constraints-warning rules#6461bkenez wants to merge 2 commits into
bkenez wants to merge 2 commits into
Conversation
…d constraints-warning rules
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the agent guidance “entry points” so that Claude-facing agent chains explicitly route contributors to the path-scoped convention library under .github/instructions/, and it adds/clarifies conventions for the canonical secret: block shape and for where render-time warnings/constraints must be authored.
Changes:
- Link
.github/instructions/*.instructions.mdinto theCLAUDE.md → AGENTS.md → .github/AGENTS.mdguidance chain so conventions are discoverable outside VS Code’sapplyTo:routing. - Expand
values-yaml.instructions.mdwith a canonical 3-keysecret:block pattern and “aux keys beside, not inside” guidance (ADR-0068 reference). - Expand
helm-templates.instructions.mdwith constraints vs warnings guidance (constraints.tpl vs NOTES.txt) plus examples and resources.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
AGENTS.md |
Adds an explicit pointer to the .github/instructions/ library in the “Additional Agent Context” chain. |
.github/AGENTS.md |
Adds a conventions pointer to the .github/instructions/ library, clarifying Claude Code routing limitations. |
.github/instructions/values-yaml.instructions.md |
Documents the canonical secret: block shape, ordering, and multi-secret/aux-key placement rules, referencing ADR-0068. |
.github/instructions/helm-templates.instructions.md |
Documents constraints vs warnings authoring patterns and prohibits hand-written render-time warnings in NOTES.txt. |
…ersion-aware constraints path
Comment on lines
+208
to
+210
| All render-time validation lives in the constraints template — `templates/common/constraints.tpl` | ||
| on 8.8+, `templates/camunda/constraints.tpl` on 8.7 and older — in two distinct shapes. | ||
| `NOTES.txt` does NOT author warnings — it only includes them: `{{ include "camunda.constraints.warnings" . | trim }}`. |
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.
Which problem does the PR fix?
Closes #6460
Agent guides in
.github/instructions/*.instructions.mdcarry CopilotapplyTo:globs that Claude Code does not auto-apply. TheCLAUDE.md→AGENTS.mdchain never pointed there, leaving agents with no routed path to the conventions. PR #6426 demonstrated this: the@paramconjunction rule was already documented invalues-yaml.instructions.mdyet violated PR-wide — because no agent path reached that file.Two additional conventions were missing entirely: the canonical
secret:block shape (ADR-0068 standardization) and the rule that render-time warnings belong incamunda.constraints.warnings, not hand-written inNOTES.txt.What's in this PR?
AGENTS.md— "Additional Agent Context" now lists.github/instructions/*.instructions.mdas authoritative path-scoped chart-coding conventions with an explicit read-before-editing instruction..github/AGENTS.md— one-line pointer to the instructions library added under## Conventions..github/instructions/values-yaml.instructions.md— §6 (formerly "Optional Secret Pattern") rewritten as "Secret Block Pattern": canonicalinlineSecret/existingSecret/existingSecretKeykey order, multi-secret reference (documentStore), the auxiliary-keys-go-beside-not-inside rule, and "don't invent new formats" citing ADR-0068. Common Mistake Standalone Gateway pod 9600 endpoint returns 503 Service Unavailable #11 added..github/instructions/helm-templates.instructions.md— NEVER/ALWAYS rules for constraints/warnings, Core Pattern Add elastic exporter as optional dependency #10 (hard-fail vs soft-warning shapes inconstraints.tpl), Common Mistake Add extra container and init container values #9.constraints.tpladded to Resources.Checklist
Before opening the PR:
make go.update-golden-only.After opening the PR: