docs: update AGENTS.md bot-review section to current CodeRabbit reality (backport #2188) - #2219
Open
mergify[bot] wants to merge 1 commit into
Open
docs: update AGENTS.md bot-review section to current CodeRabbit reality (backport #2188)#2219mergify[bot] wants to merge 1 commit into
mergify[bot] wants to merge 1 commit into
Conversation
…ty (#2188) 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 c9fb0c0) # Conflicts: # AGENTS.md # README.md
Contributor
Author
|
Cherry-pick of c9fb0c0 has failed: To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally |
Contributor
Author
Merge Protections🔴 1 of 1 protections blocking · waiting on 🙋 you
🔴 backport-conflict label must be absent to mergeWaiting for
This rule is failing.Block merge while the backport-conflict label is present. The label is auto-applied by the backport action on cherry-pick conflicts and must be manually removed after the conflict is resolved in the PR.
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
The
### Bot review workflowsection ofAGENTS.mddocumented amanual-invocation flow that no longer matches how this repository
actually works, and the
## CIlist was missing the AI Validationworkflow. This PR corrects both.
.github/copilot-instructions.mdis a symlink toAGENTS.md, so itpicks up the same correction automatically — no separate edit.
Why
The section told contributors to comment
@copilot reviewon a draft,iterate until Copilot went silent, then flip to ready and comment
@coderabbitai review. It also asserted that "auto-reviews are disabledon this repo". Following those instructions today produces the wrong
behavior: the manual CodeRabbit trigger is redundant with the automatic
review, and the Copilot invocation is not part of the review flow at
all. New contributors and coding agents read this file as authoritative.
Before / after — bot review section
Before: a two-row table pairing Copilot with draft PRs and
CodeRabbit with ready PRs, a statement that auto-reviews are disabled
and both bots are triggered manually, a 5-step workflow built around
@copilot review, and a closing rule about never triggering Copilot ona ready PR.
After: CodeRabbit is described as the automated reviewer that runs
on its own, followed by four behavior bullets — drafts are skipped;
review fires automatically on the draft to ready flip and on every
subsequent push; the walkthrough comment is commonly edited in place
rather than re-posted, so no new comment does not mean no new review;
a rate-limited CodeRabbit silently drops that review, and
@coderabbitai reviewafter the window resets is the only case where amanual trigger is appropriate. Copilot is covered in two sentences: not
part of the workflow, do not invoke it, and address any threads from a
third-party manual invocation like other reviewer feedback.
The table was dropped — with one bot and behavior rather than triggers
to describe, a bullet list carries it better.
CI list addition
Added an AI Validation entry (
.github/workflows/ai-validation.yml)between doc-linter and the Sphinx build. It cross-checks changed
docs/**/*.mdagainst the VyOS CLI definitions in thevyos-1xsourcetree for the corresponding branch and posts findings as inline review
comments plus a summary comment. It runs only when a PR touches Markdown
under
docs/, and skips with a notice when the required repositorysecrets are not configured or when the PR is a Mergify-authored
backport. The other four CI bullets were checked against
.github/workflows/andscripts/doc-linter.pyand are accurate aswritten — the doc-linter scoping claim is confirmed by the comment at
scripts/doc-linter.py:28, and the Read the Docs preview check stillreports on PRs.
README.mdpoints atAGENTS.mdfor "the Copilot/CodeRabbit bot reviewworkflow"; that phrase is updated to name CodeRabbit only, so the
pointer does not contradict the section it points to.
Review
Local CodeRabbit review against
origin/rollingcompleted with 0findings across both reviewed files (
AGENTS.md,README.md).Backport
circinuscarries the same stale section and needs this change.sagitta'sAGENTS.mdpredates the bot-review section entirely and hasnothing to correct. Backport will be requested by post-merge comment.
🤖 Generated by robots
This is an automatic backport of pull request #2188 done by Mergify.