From a360ea8ab23fbe655fdfe478082cad6b85fe310f Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Fri, 14 Aug 2026 17:41:58 +0300 Subject: docs: update AGENTS.md bot-review section to current CodeRabbit reality (#2188) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The "Bot review workflow" section documented a manual-invocation flow that no longer matches how this repo works. Stale claims removed: - "Auto-reviews are disabled on this repo — both bots are triggered manually." CodeRabbit auto-review is enabled here; the per-repo disable override was lifted. - The 5-step workflow instructing contributors to comment `@copilot review` on a draft, iterate until Copilot is silent, then flip to ready and comment `@coderabbitai review`. - The two-row bot table pairing Copilot with drafts and CodeRabbit with ready PRs. Current reality documented instead: - CodeRabbit reviews automatically on the draft -> ready flip and on every subsequent push; drafts are always skipped. - CodeRabbit commonly edits its walkthrough comment in place rather than posting a new one, so the absence of a new comment is not the absence of a review. - A rate-limited CodeRabbit silently drops that review; commenting `@coderabbitai review` after the window resets is the only case where a manual trigger is appropriate. - Copilot is no longer part of the workflow and should not be invoked. Threads from a manual invocation by someone else are addressed like any other reviewer feedback. Also adds the missing AI Validation entry to the CI list: it cross-checks changed docs Markdown against the vyos-1x source tree for the corresponding branch and posts inline plus summary review comments, runs only when a PR touches docs Markdown, and skips when the required repository secrets are unavailable or the PR is a Mergify-authored backport. README.md's pointer to the contributor guide is updated in the same pass to drop Copilot from the named workflow. Note that .github/copilot-instructions.md is a symlink to AGENTS.md, so it picks up the change automatically. 🤖 Generated by [robots](https://vyos.io) (cherry picked from commit c9fb0c0b4dd8e13ac841ee88fee8b4c6649098c5) # Conflicts: # AGENTS.md # README.md --- AGENTS.md | 37 ++++++++++++++++++++++++++++++++++++- README.md | 7 +++++++ 2 files changed, 43 insertions(+), 1 deletion(-) diff --git a/AGENTS.md b/AGENTS.md index 3da6e143..70fd78c1 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -229,15 +229,33 @@ serves and crawlers skip the redirect hop. - **vyoslinter** (`scripts/doc-linter.py` in this repo, invoked via `.github/workflows/lint-doc.yml`) — line length and IP rules, on +<<<<<<< HEAD changed files only. - **Sphinx build** — runs on Read the Docs for every PR; preview URL appears as a check. +======= + changed files under `docs/` only. Repo-root meta files + (README.md, AGENTS.md, `.github/copilot-instructions.md`) are out + of scope. +- **AI Validation** (`.github/workflows/ai-validation.yml`) — + cross-checks the changed `docs/**/*.md` against the VyOS CLI + definitions in the `vyos-1x` source tree for the corresponding + branch, and posts findings as inline review comments plus a summary + comment on the PR. Only runs when a PR touches Markdown under + `docs/`. Skips — with a notice — when the required repository + secrets aren't configured, and on Mergify-authored backport PRs. +- **Sphinx build** — runs on Read the Docs for every PR; preview URL + appears as a check. +>>>>>>> c9fb0c0b (docs: update AGENTS.md bot-review section to current CodeRabbit reality (#2188)) - **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: +CodeRabbit is the automated reviewer on this repo. It runs on its own — +in the normal case there is nothing to invoke by hand. Iterate in draft +while the work is in flux, then flip to ready when you want review. +<<<<<<< HEAD | Bot | When to trigger | How | |-----|-----------------|-----| | **Copilot** | **Draft PRs only** | Comment `@copilot review` | @@ -251,3 +269,20 @@ Workflow: 5. Address CodeRabbit threads the same way. Never trigger `@copilot review` on a ready-for-review PR. +======= +- **Drafts are skipped.** CodeRabbit ignores draft PRs entirely. +- **Review fires automatically** when a PR is flipped to ready + (`gh pr ready `), and again on every subsequent push. +- **The walkthrough comment is edited in place.** CodeRabbit usually + updates its existing comment rather than posting a new one — for + example to "no actionable comments". No new comment does not mean no + new review; re-read the existing one. +- **Rate limits silently drop a review.** If CodeRabbit is rate-limited + when an event fires, that review is skipped with no error. Comment + `@coderabbitai review` once the limit window resets. This is the only + case where triggering it by hand is appropriate. + +Copilot is not part of this workflow — do not invoke `@copilot review`. +If Copilot threads do appear because someone invoked it manually, +address them like any other reviewer feedback. +>>>>>>> c9fb0c0b (docs: update AGENTS.md bot-review section to current CodeRabbit reality (#2188)) diff --git a/README.md b/README.md index ab46133b..587658e3 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,13 @@ Output lands in `docs/_build/html/`. ## Contributing +<<<<<<< HEAD See [AGENTS.md](AGENTS.md) for the full contributor guide — MyST conventions, CLI directive syntax, IP-address rules, linter suppression markers, and the Copilot / CodeRabbit bot workflow. +======= +See [AGENTS.md](AGENTS.md) for the full contributor guide — MyST source +conventions, the VyOS command directives (`cfgcmd` / `opcmd` / +`cmdincludemd`), IP-address rules, the linter and its suppression markers, +and the CodeRabbit bot review workflow. +>>>>>>> c9fb0c0b (docs: update AGENTS.md bot-review section to current CodeRabbit reality (#2188)) -- cgit v1.2.3