diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-07 16:16:06 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-07 16:16:06 +0300 |
| commit | 34720ce1d2c0d149fd5e1867a398d2c49b33ce0f (patch) | |
| tree | 3696cb83925351df703f2e01a442103b5501eef9 /AGENTS.md | |
| parent | aa476850b2a8efd27d3307dc9bccb9df2b85a9b9 (diff) | |
| download | vyos-documentation-34720ce1d2c0d149fd5e1867a398d2c49b33ce0f.tar.gz vyos-documentation-34720ce1d2c0d149fd5e1867a398d2c49b33ce0f.zip | |
docs(agents-md): document bot review workflow (Copilot=draft, CodeRabbit=ready)
Copilot review must only be triggered on draft PRs.
CodeRabbit review must only be triggered on ready-for-review PRs.
Auto-reviews are disabled on this repo so CodeRabbit requires manual trigger.
🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to 'AGENTS.md')
| -rw-r--r-- | AGENTS.md | 18 |
1 files changed, 18 insertions, 0 deletions
@@ -240,3 +240,21 @@ serves and crawlers skip the redirect hop. - **Sphinx build** — runs on Read the Docs for every PR; preview URL appears as a check. - **CLA check** — contributors must sign the VyOS CLA before merge. - **Conflict check** — fails the PR if it doesn't merge cleanly into base. + +### Bot review workflow + +Two bots run at separate stages — do not mix them: + +| Bot | When to trigger | How | +|-----|-----------------|-----| +| **Copilot** | **Draft PRs only** | Comment `@copilot review` | +| **CodeRabbit** | **Ready-for-review PRs only** | Comment `@coderabbitai review` (auto-reviews are disabled on this repo) | + +Workflow: +1. Open PR as draft (`gh pr create --draft`). +2. Iterate; when complete, comment `@copilot review`. +3. Address Copilot threads, re-request after each fix round until Copilot is silent. +4. Flip to ready (`gh pr ready <num>`), then comment `@coderabbitai review`. +5. Address CodeRabbit threads the same way. + +Never trigger `@copilot review` on a ready-for-review PR. |
