-
Notifications
You must be signed in to change notification settings - Fork 0
T8595: add AGENTS.md + Copilot symlink for the vyos-org central CodeRabbit baseline #4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
andamasov
wants to merge
2
commits into
production
Choose a base branch
from
agents-md-T8595
base: production
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../AGENTS.md |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # AGENTS.md | ||
|
|
||
| ## Project purpose | ||
|
|
||
| Central [CodeRabbit](https://www.coderabbit.ai/) configuration baseline for the `vyos` (public) GitHub organisation. `.coderabbit.yaml` here is applied to every `vyos/<repo>` PR review unless the consumer carries its own `.coderabbit.yaml` with `inheritance: true`. Discovery is name-load-bearing β CodeRabbit's [central-configuration](https://docs.coderabbit.ai/configuration/central-configuration) feature looks up the literal repo name `coderabbit` in each org; renaming breaks the integration. | ||
|
|
||
| Sibling β **not** twin β of [VyOS-Networks/coderabbit](https://github.com/VyOS-Networks/coderabbit). Several intentional divergences (see "Cross-repo context"); never blindly mirror changes across. | ||
|
|
||
| ## Tech stack | ||
|
|
||
| - One YAML config (`.coderabbit.yaml`) validated against `https://coderabbit.ai/integrations/schema.v2.json`. | ||
| - No build, no tests, no scripts. Default branch `production`. | ||
|
|
||
| ## Build / test / run | ||
|
|
||
| No local execution. Edit `.coderabbit.yaml` with `yaml-language-server` enabled to honour the in-file `$schema` directive. CodeRabbit re-reads the baseline on the next PR webhook in any consumer. | ||
|
|
||
| ## Repository layout | ||
|
|
||
| - `.coderabbit.yaml` β the org-wide baseline. | ||
| - `CODEOWNERS` β Maintainers team owns all changes. | ||
| - `README.md` β operator-facing primer (inheritance contract, per-repo override pattern, rollback). | ||
|
|
||
| ## Cross-repo context | ||
|
|
||
| - Per-repo overrides MUST pin `inheritance: true` (load-bearing). Without it the per-repo file **fully replaces** this baseline; with it CodeRabbit deep-merges (objects merge, arrays union, scalars child-wins). | ||
| - **Public-repo edit blindspot:** CodeRabbit ignores `.coderabbit.yaml` changes coming from PRs against public repos β it reads only the base-branch version. PRs that modify this file therefore cannot be self-validated by CodeRabbit. Treat the private sibling's CI as the canary for the same class of bugs. | ||
| - **Divergences from [VyOS-Networks/coderabbit](https://github.com/VyOS-Networks/coderabbit):** | ||
| - `early_access: true` here (public-org tolerance for new CodeRabbit features); `false` there. | ||
| - `chat.integrations.jira.usage` and `knowledge_base.jira.usage` are both `disabled` here β the Atlassian OAuth grant is attached to `VyOS-Networks` only (CodeRabbit allows one GitHub-org β Jira-tenant link per install). | ||
| - `knowledge_base.linked_repositories` lists `ansible/ansible` because `vyos.vyos` (Ansible collection) lives in this org; the Networks baseline has no linked repos. | ||
| - Networks `base_branches` adds `git-actions` (used by its `.github` repo); this list does not. | ||
|
|
||
| ## Conventions | ||
|
|
||
| - Default branch: `production`. Visibility: public. | ||
| - Commit / PR title format: `T<num>: <description>` (or `scope: T<num>: <description>`); enforced by Mergify central rule from [vyos/mergify](https://github.com/vyos/mergify). | ||
| - Org-UI Web dashboard (Global Overrides) MUST stay empty β YAML is the single source of truth. Any setting present in Org-UI should be lifted into this file and the Org-UI editor cleared. | ||
| - Any change merged to `production` ships to every consumer's next PR webhook immediately. No staging. | ||
|
|
||
| ## Notes for future contributors | ||
|
|
||
| - Authority: [T8764](https://vyos.dev/T8764) (parent), [T8765](https://vyos.dev/T8765) (provisioning). Confluence: page `847151111`. | ||
| - Rollback: `git revert` the offending commit, or set the file body to `{}` β every inheriting repo falls back to CodeRabbit hardcoded defaults on the next webhook. | ||
| - Cross-org gotcha: the gen-1 mirror pipeline propagates dotfiles between `vyos/<repo>` and `VyOS-Networks/<repo>` mirrors. For mirrored consumer repos, the per-repo `.coderabbit.yaml` on the `vyos` source is the source of truth for both. The only cross-org-safe value for Jira knobs in a per-repo file is `usage: auto` (self-disables on public, activates on private). | ||
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.
Uh oh!
There was an error while loading. Please reload this page.