general: T8595: add AGENTS.md#1
Conversation
📝 WalkthroughSummary by CodeRabbit
WalkthroughThis PR establishes the vyos/coderabbit central baseline configuration repository. AGENTS.md documents the org-wide CodeRabbit baseline for all vyos/* repositories, covering the inheritance model, per-repo override conventions, schema pinning, operational behavior, and rollback procedures. The copilot-instructions.md file is updated to reference this baseline documentation. ChangesCodeRabbit Baseline Documentation
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/copilot-instructions.md:
- Line 1: The file .github/copilot-instructions.md is a plain text file
containing "../AGENTS.md" but should be a symlink to the actual AGENTS.md;
remove the plain file and replace it with a symbolic link named
.github/copilot-instructions.md that points to ../AGENTS.md (ensure ../AGENTS.md
exists in the repo), then git add the symlink so the repository stores a symlink
rather than literal text.
In `@AGENTS.md`:
- Line 21: The doc incorrectly states the central baseline `.coderabbit.yaml`
pins `inheritance: true`; update AGENTS.md to remove or rephrase that claim so
it no longer implies the baseline has a parent — clarify that only per-repo
override files should set `inheritance: true` to deep-merge with the central
baseline and that the central `.coderabbit.yaml` should not set `inheritance:
true`.
- Line 27: The sentence currently reads "Every per-repo override file MUST also
pin `inheritance: true`" which wrongly implies the central baseline has that
flag; edit the sentence to remove the word "also" so it reads "Every per-repo
override file MUST pin `inheritance: true`", ensuring the documentation clearly
states that only per-repo overrides must set `inheritance: true`.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Central YAML (inherited), Organization UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 727d2b96-d653-418a-a98d-fa5a38d976ed
📒 Files selected for processing (2)
.github/copilot-instructions.mdAGENTS.md
📜 Review details
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: vyos/coderabbit
Timestamp: 2026-05-09T19:14:36.149Z
Learning: Design agents to be task-focused with clear, singular responsibilities
Learnt from: CR
Repo: vyos/coderabbit
Timestamp: 2026-05-09T19:14:36.149Z
Learning: Implement proper error handling and recovery mechanisms in agent workflows
Learnt from: CR
Repo: vyos/coderabbit
Timestamp: 2026-05-09T19:14:36.149Z
Learning: Document agent behavior, parameters, and expected outputs clearly
Learnt from: CR
Repo: vyos/coderabbit
Timestamp: 2026-05-09T19:14:36.149Z
Learning: Use configuration files for agent parameters rather than hardcoding values
Learnt from: CR
Repo: vyos/coderabbit
Timestamp: 2026-05-09T19:14:36.149Z
Learning: Ensure agents can be tested independently with mocked dependencies
Learnt from: CR
Repo: vyos/coderabbit
Timestamp: 2026-05-09T19:14:36.149Z
Learning: Maintain backward compatibility when updating agent interfaces
Learnt from: CR
Repo: vyos/coderabbit
Timestamp: 2026-05-09T19:14:42.289Z
Learning: Commit/PR title format must follow `component: T12345: description` pattern with Phorge task ID at https://vyos.dev
Learnt from: CR
Repo: vyos/coderabbit
Timestamp: 2026-05-09T19:14:42.289Z
Learning: Use deep-merge inheritance model where objects are deep-merged, arrays are unioned, and scalars favor child values in `.coderabbit.yaml` configuration
Learnt from: CR
Repo: vyos/coderabbit
Timestamp: 2026-05-09T19:14:42.289Z
Learning: Default branch for this repository must be `production`
🪛 LanguageTool
AGENTS.md
[grammar] ~37-~37: Ensure spelling is correct
Context: ...rmat: component: T12345: description. Phorge task ID at https://vyos.dev mandatory. ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔍 Remote MCP Context7
Summary of Relevant Context for PR Review
Based on CodeRabbit's official documentation, here is the relevant context for reviewing this PR:
Key Documentation Standards:
Configuration Inheritance Mechanism:
The PR document correctly states that per-repository overrides must include inheritance: true to enable deep-merging behavior. According to CodeRabbit documentation, this inheritance model works as follows:
- Scalar values are overridden by child configurations
- Objects undergo deep merge where child properties override parent properties at each nesting level
- Arrays append unique parent items after child items, deduplicated by stable keys like
path,label,name,id, orkey
Central Configuration Purpose:
The vyos/coderabbit repository serves as a central configuration repository. Per CodeRabbit standards, this approach:
- Maintains organization-wide defaults in a dedicated central repository
- Automatically applies settings to repositories without their own configuration
- Ensures organization-wide consistency and simplifies management
- Follows a strict priority order where repository-specific
.coderabbit.yamloverrides the central repository's configuration
Symlink Strategy Validation:
The PR includes .github/copilot-instructions.md as a symlink to AGENTS.md. This aligns with CodeRabbit's configuration management approach, using YAML files for hierarchical configuration.
Review Considerations:
- Inheritance Flag Requirement: The PR's emphasis on requiring
inheritance: truein per-repository overrides is correctly aligned with CodeRabbit's documented merge behavior - Array Deduplication Rules: Any
path_instructionsarrays in child repositories would be properly merged with parent arrays using the documented child-first deduplication strategy - Central Repository Setup: The PR's documentation of the repository role (single
.coderabbit.yamlas the baseline) matches CodeRabbit's central configuration setup requirements
🔀 Multi-repo context ansible/ansible
Linked repositories findings
ansible/ansible
- Repository already contains an AGENTS.md at the repo root. [::ansible/ansible::AGENTS.md]
- CLAUDE.md references AGENTS.md. [::ansible/ansible::CLAUDE.md:1]
- Many files reference "vyos" (modules, runtime redirects, tests, inventory templates), indicating this repo consumes vyos-related configuration/plugins and may be affected by documentation/config conventions for vyos baselines. Examples:
- test/sanity/package-data.py lists 'AGENTS.md'. [::ansible/ansible::test/sanity/code-smell/package-data.py:36]
- Multiple runtime/config redirects to vyos plugins and collections in lib/ansible/config/{base.yml,ansible_builtin_runtime.yml} (numerous lines). [::ansible/ansible::lib/ansible/config/ansible_builtin_runtime.yml]
- Test/integration targets reference vyos modules and action plugins. [::ansible/ansible::test/integration/targets/module_defaults/test_defaults.yml]
- .github/copilot-instructions.md is not present in this repository (no symlink to create). [::ansible/ansible::.github]
Conclusion: AGENTS.md already exists and is referenced in this repo; the PR's addition of AGENTS.md + a .github/copilot-instructions.md symlink in vyos/coderabbit is relevant (ansible uses AGENTS.md and vyos artifacts), but ansible/ansible itself does not need a copilot-instructions.md symlink. Reviewers should note existing AGENTS.md usage and vyos references when assessing cross-repo fleet rollout.
🔇 Additional comments (4)
AGENTS.md (4)
1-8: LGTM: Clear central configuration purpose.Correctly documents CodeRabbit's central-configuration feature and public transparency rationale.
42-47: LGTM: Cross-repo context documented.Sibling repo, Phorge task references, and overlay catalog pointer are clear. Consistent with linked repos findings (ansible/ansible AGENTS.md usage).
48-50: LGTM: Clear rollback procedure.
git revertor{}fallback strategy is correct and practical.
39-39: Schema is correctly pinned. The.coderabbit.yamlfile at repository root has the required YAML language server schema directive on line 1, matching the convention documented in AGENTS.md line 39.
| @@ -0,0 +1 @@ | |||
| ../AGENTS.md No newline at end of file | |||
There was a problem hiding this comment.
File must be a symlink, not text content.
PR description states this should be "a .github/copilot-instructions.md symlink" but the file appears to be regular text containing ../AGENTS.md rather than an actual symlink. Git and GitHub support symlinks natively.
Create as actual symlink:
ln -s ../AGENTS.md .github/copilot-instructions.md
git add .github/copilot-instructions.mdTools reading .github/copilot-instructions.md expect either the target content (via symlink resolution) or standalone instructions, not a path string.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.github/copilot-instructions.md at line 1, The file
.github/copilot-instructions.md is a plain text file containing "../AGENTS.md"
but should be a symlink to the actual AGENTS.md; remove the plain file and
replace it with a symbolic link named .github/copilot-instructions.md that
points to ../AGENTS.md (ensure ../AGENTS.md exists in the repo), then git add
the symlink so the repository stores a symlink rather than literal text.
|
|
||
| ## Repository layout | ||
|
|
||
| - `.coderabbit.yaml` — central baseline. Pins `inheritance: true` so per-repo overrides deep-merge instead of fully replacing. |
There was a problem hiding this comment.
Incorrect: central baseline should NOT pin inheritance: true.
Line 21 states the central baseline pins inheritance: true, but the central config has no parent to inherit from—it IS the baseline. Only per-repo override files need inheritance: true to deep-merge with this central baseline (correctly stated at line 27).
Remove or rephrase line 21 to avoid contradiction:
-- `.coderabbit.yaml` — central baseline. Pins `inheritance: true` so per-repo overrides deep-merge instead of fully replacing.
+- `.coderabbit.yaml` — central baseline. Per-repo overrides must pin `inheritance: true` to deep-merge instead of fully replacing.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - `.coderabbit.yaml` — central baseline. Pins `inheritance: true` so per-repo overrides deep-merge instead of fully replacing. | |
| - `.coderabbit.yaml` — central baseline. Per-repo overrides must pin `inheritance: true` to deep-merge instead of fully replacing. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@AGENTS.md` at line 21, The doc incorrectly states the central baseline
`.coderabbit.yaml` pins `inheritance: true`; update AGENTS.md to remove or
rephrase that claim so it no longer implies the baseline has a parent — clarify
that only per-repo override files should set `inheritance: true` to deep-merge
with the central baseline and that the central `.coderabbit.yaml` should not set
`inheritance: true`.
|
|
||
| ## Inheritance model (load-bearing) | ||
|
|
||
| Every per-repo override file MUST also pin `inheritance: true`. Without it, the override fully replaces this baseline. With it, CodeRabbit deep-merges per the [configuration-inheritance docs](https://docs.coderabbit.ai/configuration/configuration-inheritance): |
There was a problem hiding this comment.
Remove "also" to fix inheritance documentation.
The word "also" incorrectly implies the central baseline has inheritance: true (echoing line 21's error). Only per-repo overrides need this flag.
-Every per-repo override file MUST also pin `inheritance: true`. Without it, the override fully replaces this baseline. With it, CodeRabbit deep-merges per the [configuration-inheritance docs](https://docs.coderabbit.ai/configuration/configuration-inheritance):
+Every per-repo override file MUST pin `inheritance: true`. Without it, the override fully replaces this baseline. With it, CodeRabbit deep-merges per the [configuration-inheritance docs](https://docs.coderabbit.ai/configuration/configuration-inheritance):📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Every per-repo override file MUST also pin `inheritance: true`. Without it, the override fully replaces this baseline. With it, CodeRabbit deep-merges per the [configuration-inheritance docs](https://docs.coderabbit.ai/configuration/configuration-inheritance): | |
| Every per-repo override file MUST pin `inheritance: true`. Without it, the override fully replaces this baseline. With it, CodeRabbit deep-merges per the [configuration-inheritance docs](https://docs.coderabbit.ai/configuration/configuration-inheritance): |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@AGENTS.md` at line 27, The sentence currently reads "Every per-repo override
file MUST also pin `inheritance: true`" which wrongly implies the central
baseline has that flag; edit the sentence to remove the word "also" so it reads
"Every per-repo override file MUST pin `inheritance: true`", ensuring the
documentation clearly states that only per-repo overrides must set `inheritance:
true`.
1 participant
Adds
AGENTS.mdat the repo root plus.github/copilot-instructions.mdsymlink (compatibility with Copilot code review, which only reads the.github/copilot-instructions.mdpath).Part of the T8595 fleet rollout. Schema decision (AGENTS.md primary + symlink) is documented on T8595.
This repo was added to T8595 scope on 2026-05-09 alongside its sibling and the central Mergify repos for fleet uniformity.
🤖 Generated by robots