Skip to content

T8595: add AGENTS.md + Copilot symlink for the vyos-org central CodeRabbit baseline#4

Open
andamasov wants to merge 2 commits into
productionfrom
agents-md-T8595
Open

T8595: add AGENTS.md + Copilot symlink for the vyos-org central CodeRabbit baseline#4
andamasov wants to merge 2 commits into
productionfrom
agents-md-T8595

Conversation

@andamasov
Copy link
Copy Markdown
Member

Summary

Adds AGENTS.md at repo root with a .github/copilot-instructions.md symlink to ../AGENTS.md, completing the AGENTS.md fleet rollout coverage for the vyos-org central CodeRabbit baseline.

Content is intentionally divergent from VyOS-Networks/coderabbit — see the "Cross-repo context" section for the public-org-specific framing (early_access on, Jira off, ansible/ansible linked).

Authority: T8595, with T8764 / T8765 context.

Local CodeRabbit (Phase 0 per WD-1334): 0 findings.

Test plan

  • CodeRabbit auto-review (post-flip-to-ready) is clean
  • Copilot review (manual @copilot review) is clean
  • Maintainers approval before merge

🤖 Generated by robots

…abbit baseline

Authority: T8595 (AGENTS.md fleet rollout).

🤖 Generated by [robots](https://vyos.io)
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 16, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: c61fc6e1-5b7d-4308-8440-ccb56fbafd38

📥 Commits

Reviewing files that changed from the base of the PR and between 5899dac and 772c2fe.

📒 Files selected for processing (1)
  • AGENTS.md
📜 Recent review details
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: vyos/coderabbit

Timestamp: 2026-05-17T09:36:10.469Z
Learning: Use agent-based architectures for modular, scalable application design
Learnt from: CR
Repo: vyos/coderabbit

Timestamp: 2026-05-17T09:36:10.469Z
Learning: Implement agents with clear responsibilities and well-defined interfaces
Learnt from: CR
Repo: vyos/coderabbit

Timestamp: 2026-05-17T09:36:10.469Z
Learning: Use message passing for agent-to-agent communication
Learnt from: CR
Repo: vyos/coderabbit

Timestamp: 2026-05-17T09:36:10.469Z
Learning: Ensure agents are stateless or manage state explicitly and safely
Learnt from: CR
Repo: vyos/coderabbit

Timestamp: 2026-05-17T09:36:10.469Z
Learning: Document agent responsibilities, inputs, outputs, and contracts clearly
Learnt from: CR
Repo: vyos/coderabbit

Timestamp: 2026-05-17T09:36:19.968Z
Learning: Do not rename the `coderabbit` repository in the vyos GitHub organization as CodeRabbit's central-configuration feature discovers it by literal name
Learnt from: CR
Repo: vyos/coderabbit

Timestamp: 2026-05-17T09:36:19.968Z
Learning: Use commit/PR title format `T<num>: <description>` or `scope: T<num>: <description>` as enforced by Mergify central rule
Learnt from: CR
Repo: vyos/coderabbit

Timestamp: 2026-05-17T09:36:19.968Z
Learning: Keep the Org-UI Web dashboard Global Overrides empty; maintain YAML as the single source of truth for CodeRabbit configuration
Learnt from: CR
Repo: vyos/coderabbit

Timestamp: 2026-05-17T09:36:19.968Z
Learning: For mirrored consumer repositories between vyos and VyOS-Networks orgs, treat the per-repo `.coderabbit.yaml` in the vyos source as the source of truth for both mirrors
🪛 LanguageTool
AGENTS.md

[uncategorized] ~32-~32: The official name of this software platform is spelled with a capital “H”.
Context: ...anchesaddsgit-actions(used by its.github` repo); this list does not. ## Convent...

(GITHUB)

🔍 Remote MCP Context7

Additional relevant facts for PR review

  • To enable org-level merging the central config must set inheritance: true at the root of the central or repository .coderabbit.yaml. Without it the merge chain stops at that level.
  • Merge semantics (directly relevant to AGENTS.md wording / intent):
    • Scalars: child repo values override parent values (child wins).
    • Objects: deep-merged; child properties override parent properties at each nesting level.
    • Arrays: child-first append, then unique parent items are appended; deduplication is done by a stable key such as path, label, name, id, or key.
  • Inheritance chaining: if a parent config also sets inheritance: true, the chain continues upward until a level with inheritance: false or unset is reached.
  • Example snippet from docs showing inheritance: true usage and merged repo-level config pattern (useful to compare against AGENTS.md examples or to include in reviewer guidance).

Sources:

  • CodeRabbit documentation (Configuration inheritance & merge behavior) via Context7 resolver for CodeRabbit.,
🔀 Multi-repo context ansible/ansible

Linked repositories findings

ansible/ansible

  • AGENTS.md exists at repo root and provides agent guidance, testing commands, licensing notes, and PR review checklist. [::ansible/ansible::AGENTS.md:1-200]
  • Tests and packaging reference AGENTS.md (sdist/wheel collection ignores/include). Example: test/sanity/code-smell/package-data.py includes 'AGENTS.md' in ignore patterns. [::ansible/ansible::test/sanity/code-smell/package-data.py:1-80]
  • The runtime redirect mapping contains extensive vyos entries (modules, network.argspec, facts, action plugins, terminal, etc.), indicating ansible/ansible redirects many vyos module names to vyos collection implementations. Key locations: lib/ansible/config/ansible_builtin_runtime.yml around lines 7528–7568, 8699–8782, 8923–9444. Examples:
    • vyos_ospfv2, vyos_interface, vyos_facts, vyos_ping, vyos_config, vyos_system, etc. [::ansible/ansible::lib/ansible/config/ansible_builtin_runtime.yml:7528-7568]
    • network.vyos.* argspec/config/facts mappings. [::ansible/ansible::lib/ansible/config/ansible_builtin_runtime.yml:8699-8782]
    • additional vyos redirects and terminal/action/plugin mappings. [::ansible/ansible::lib/ansible/config/ansible_builtin_runtime.yml:8923-9444]
  • Integration test targets reference vyos test modules and action plugin behavior (test/integration/targets/module_defaults/*). [::ansible/ansible::test/integration/targets/module_defaults/test_defaults.yml:130-150]
  • Search for coderabbit/.coderabbit.yaml returned no matches in this repository. [::ansible/ansible::]

Conclusion: The PR adding AGENTS.md and a copilot symlink in vyos/coderabbit is contextually relevant: ansible/ansible already maintains AGENTS.md and contains many vyos-related redirects and tests that may rely on organization-wide agent guidance or public-org framing. This cross-repo linkage is supported by direct references found above.

🔇 Additional comments (7)
AGENTS.md (7)

5-5: Past review comment addressed.

The inheritance: true behavior is now correctly documented. Line 5 clearly states that per-repo configs WITH inheritance: true merge with the baseline, and WITHOUT it they fully replace it. This is consistent with line 26 and matches CodeRabbit's documented merge semantics.


9-16: LGTM!


18-22: LGTM!


24-32: LGTM!


34-39: LGTM!


41-45: LGTM!


1-1: ⚡ Quick win

Symlink correctly configured.

.github/copilot-instructions.md properly points to ../AGENTS.md.


📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added centralized organization-wide guidance covering automation/configuration policies, branch/PR conventions, and contributor notes.
    • Updated local instruction to reference the new centralized guidance for consistent review and validation behavior.

Walkthrough

Adds an org-level AGENTS.md (lines 1-45) documenting CodeRabbit baseline, schema, PR webhook model, override semantics, conventions and contributor notes, and updates .github/copilot-instructions.md (line 1) to reference ../AGENTS.md.

Changes

CodeRabbit baseline configuration

Layer / File(s) Summary
Organization configuration baseline
AGENTS.md (lines 1-45), .github/copilot-instructions.md (line 1)
Introduces AGENTS.md as the central org document describing CodeRabbit baseline application to vyos repositories (schema/validation, PR webhook behavior, inheritance/override rules, cross-repo blindspots, divergences from VyOS-Networks, production branch conventions, rollback/contributor guidance). Updates .github/copilot-instructions.md to point to ../AGENTS.md.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed Title clearly summarizes the main change: adding AGENTS.md and a Copilot symlink for the vyos-org CodeRabbit baseline configuration.
Description check ✅ Passed Description is directly related to the changeset, detailing the addition of AGENTS.md and .github/copilot-instructions.md symlink with context and authority references.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch agents-md-T8595

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@andamasov
Copy link
Copy Markdown
Member Author

@copilot review

Copy link
Copy Markdown

Copilot AI commented May 16, 2026

@copilot review

Ran Copilot follow-up review on this PR state: no additional changes were required for commit 5899dac (AGENTS.md + symlink setup only).

@andamasov andamasov marked this pull request as ready for review May 16, 2026 15:36
@andamasov
Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 16, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@andamasov
Copy link
Copy Markdown
Member Author

@coderabbitai full review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 16, 2026

✅ Actions performed

Full review triggered.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 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 `@AGENTS.md`:
- Line 5: Update the sentence on Line 5 so it correctly states that repositories
that include `.coderabbit.yaml` with `inheritance: true` will merge with (not
opt out of) the central CodeRabbit baseline; specifically, change the wording
that currently implies exclusion to explicitly say `inheritance: true` enables
merging with the central baseline defined by CodeRabbit's central-configuration
(and keep references to the repo name lookup `coderabbit` and the `vyos/<repo>`
application behavior intact).
🪄 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: 648943ec-db56-43f6-968a-79ca08d63ce5

📥 Commits

Reviewing files that changed from the base of the PR and between ad39258 and 5899dac.

📒 Files selected for processing (2)
  • .github/copilot-instructions.md
  • AGENTS.md
📜 Review details
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: vyos/coderabbit

Timestamp: 2026-05-16T17:49:33.428Z
Learning: Agents should be designed with clear separation of concerns - each agent should have a single, well-defined responsibility
Learnt from: CR
Repo: vyos/coderabbit

Timestamp: 2026-05-16T17:49:33.428Z
Learning: Agent communication should use standardized message formats and protocols
Learnt from: CR
Repo: vyos/coderabbit

Timestamp: 2026-05-16T17:49:33.428Z
Learning: Agents should include error handling and graceful degradation mechanisms
Learnt from: CR
Repo: vyos/coderabbit

Timestamp: 2026-05-16T17:49:33.428Z
Learning: Agent state management should be explicit and traceable
Learnt from: CR
Repo: vyos/coderabbit

Timestamp: 2026-05-16T17:49:39.339Z
Learning: Ensure Org-UI Web dashboard (Global Overrides) stays empty — YAML configuration is the single source of truth; any setting present in Org-UI should be lifted into `.coderabbit.yaml` and the Org-UI editor cleared
Learnt from: CR
Repo: vyos/coderabbit

Timestamp: 2026-05-16T17:49:39.339Z
Learning: Commit and PR titles must follow the format `T<num>: <description>` or `scope: T<num>: <description>` as enforced by Mergify central rules
Learnt from: CR
Repo: vyos/coderabbit

Timestamp: 2026-05-16T17:49:39.339Z
Learning: Keep the default branch as `production` with public visibility for the coderabbit configuration repository
Learnt from: CR
Repo: vyos/coderabbit

Timestamp: 2026-05-16T17:49:39.339Z
Learning: Do not rename the coderabbit repository as CodeRabbit's central-configuration feature looks up the literal repo name `coderabbit` in the org; renaming breaks the integration
🪛 LanguageTool
AGENTS.md

[uncategorized] ~32-~32: The official name of this software platform is spelled with a capital “H”.
Context: ...anchesaddsgit-actions(used by its.github` repo); this list does not. ## Convent...

(GITHUB)

🔍 Remote MCP Context7

Relevant facts found (concise, directly applicable to this PR review)

  • Central .coderabbit.yaml behavior: adding AGENTS.md / central repo is the standard way to set org-wide defaults that repos inherit; repositories without their own .coderabbit.yaml will receive those defaults.

  • To enable deep/merged inheritance the central config must include inheritance: true at the root; that flag enables per-repo deep-merge behavior (child wins for scalars, objects merged, arrays merged with de-duplication). Verify AGENTS.md/.coderabbit.yaml references this flag if the intent is org-wide inheritance.

  • Override semantics to check in review: repository-level .coderabbit.yaml files take precedence for scalars; objects and arrays are merged according to documented rules — confirm AGENTS.md wording matches these semantics so maintainers understand override effects.

  • Verification guidance: post-merge, run CodeRabbit auto-review (flip-to-ready) to ensure the central config is applied and that no unexpected repo-level diffs appear; this aligns with the PR's test plan.

Sources/tools used:

  • Resolved relevant CodeRabbit documentation entry for queries: Context7 library resolution.
  • Queried CodeRabbit docs for central configuration, inheritance flag, merge semantics, and merged-configuration examples.
🔀 Multi-repo context ansible/ansible

Linked repositories findings

ansible/ansible

  • AGENTS.md exists at repo root and contains agent guidance and CI/testing commands relevant to reviewers/agents. [::ansible/ansible::AGENTS.md]
  • Codebase contains extensive vyos redirects mapping module/plugin names to vyos implementations in lib/ansible/config/ansible_builtin_runtime.yml (many entries around lines ~7528–7560, ~8699–8782, ~8923–9444). These show Ansible provides built-in redirects for numerous vyos modules/plugins. [::ansible/ansible::lib/ansible/config/ansible_builtin_runtime.yml:7528-7560,8699-8782,8923-9444]
  • Tests/reference fixtures mention AGENTS.md and include vyos-focused integration test targets:
    • test/sanity/code-smell/package-data.py references 'AGENTS.md'. [::ansible/ansible::test/sanity/code-smell/package-data.py:36]
    • Integration targets and modules under test/integration/targets/module_defaults reference vyos modules/plugins and vyosfacts (e.g., test_defaults.yml and collections plugins). [::ansible/ansible::test/integration/targets/module_defaults/test_defaults.yml:134-150, ::ansible/ansible::test/integration/targets/module_defaults/collections/ansible_collections/testns/testcoll/plugins/modules/vyosfacts.py:1-30]

Summary assessment: The coderabbit PR adding AGENTS.md and linking to ansible/ansible is relevant — ansible/ansible already maintains an AGENTS.md and contains many vyos redirects and tests that rely on vyos module names; this cross-repo linkage is valid context for reviewers.

🔇 Additional comments (2)
AGENTS.md (1)

26-46: LGTM!

.github/copilot-instructions.md (1)

1-1: LGTM!

Comment thread AGENTS.md Outdated
Address CodeRabbit L5 finding (PR #4) — the original wording could be read as
saying inheritance: true causes consumers to be excluded from the central
baseline, when in fact it enables deep-merge with the baseline. Rewrite to
state the merge contract explicitly.

🤖 Generated by [robots](https://vyos.io)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants