Repository navigation
docs(review): correct the trigger permission level (skip docs deferred to fullsend#6587) #1247
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
base: main
Are you sure you want to change the base?
Changes from 1 commit
ab6e2fa
2ec5ada
1946583
d4bfb17
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,7 +17,7 @@ No additional setup is required beyond the standard fullsend configuration. | |
|
|
||
| The review agent runs automatically when: | ||
|
|
||
| - A PR/MR is opened | ||
| - A PR/MR is opened (drafts excluded — see below) | ||
| - New commits are pushed to a PR/MR (synchronized) | ||
| - A PR/MR is moved out of draft | ||
|
|
||
|
|
@@ -27,6 +27,18 @@ All automatic triggers require the actor to have write-level repository permissi | |
|
|
||
| It can also be triggered manually with the `/fs-review` command. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. MEDIUM — Triggers section still claims write-level permission; fullsend main gates review at triage Independent of #6587. On fullsend Suggestion: Update line 26 and line 48 to "triage-level repository permission or higher (triage, write, maintain, or admin)", matching fullsend |
||
|
|
||
| ### Automatic skips | ||
|
|
||
| The review agent does not run automatically — `/fs-review` still works — when: | ||
|
|
||
| - **The PR/MR is a draft.** It runs once the PR/MR is marked ready for review. (In per-repo installs, applying `ready-for-review` to a draft still dispatches — the label is an explicit request.) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. MEDIUM — "the label is an explicit request" overstates what The parenthetical "(In per-repo installs, applying Suggestion: Reword to: "(In per-repo installs, applying
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. MEDIUM — Draft bullet says "PR/MR" but none of the three skips exist on GitLab Line 20 says "A PR/MR is opened (drafts excluded — see below)" and line 34 says "The PR/MR is a draft.", but the skips are GitHub-only. Verified: #6587 leaves Suggestion: Scope the section to GitHub — e.g. open with "On GitHub installs, the review agent does not run automatically … when:" — and drop "/MR" from the draft bullet and from the line-20 parenthetical, or add an explicit note that GitLab MR pipelines do not implement these skips. |
||
| - **The PR carries the `fullsend-no-review` label.** See [Control labels](#control-labels) below. | ||
| - **The diff is documentation prose only** (per-repo installs). A PR whose changed files are all markdown under `docs/guides/`, `docs/problems/`, `docs/agents/` or `docs/glossary.md`, with no executable markup outside code (`<script>`/`<style>` blocks, `head:` frontmatter, `{{ }}` interpolation, bound attributes or directives on raw HTML), is skipped with a notice in the job summary. Markdown anywhere else — every other `docs/` directory, `skills/*/SKILL.md`, `AGENTS.md`, `CLAUDE.md` — and lockfiles are still reviewed. A page that cannot be read, or a truncated file listing, never skips. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. MEDIUM — Exact allowlist and scan rules transcribed from an unmerged PR that has already changed mid-review The prose-skip bullet states as settled fact the four-path allowlist ( Suggestion: Reduce the bullet to the stable contract ("a small allowlist of prose directories under |
||
|
|
||
| A push skipped for any of these reasons still clears `ready-for-merge` and `ready-for-review`, so the labels never describe commits nobody reviewed. | ||
|
|
||
| See [fullsend ADR 0096](https://github.com/fullsend-ai/fullsend/blob/main/docs/ADRs/0096-skip-provably-unnecessary-review-dispatch.md) for the rationale. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. HIGH — Documents behaviour that is not on fullsend main yet; the ADR link 404s today Every behaviour this section documents — the draft skip, the Suggestion: Hold this PR until fullsend#6587 merges — mark it draft or add an explicit "blocked by fullsend-ai/fullsend#6587" line to the body — and re-check that the ADR 0096 URL resolves on |
||
|
|
||
| ## Commands | ||
|
|
||
| | Command | Where | Effect | | ||
|
|
@@ -39,14 +51,15 @@ The `/fs-review` command does not accept arguments. | |
|
|
||
| ## Control labels | ||
|
|
||
| These labels reflect the review outcome and are updated after each review. | ||
| These labels reflect the review outcome and are updated after each review; `fullsend-no-review` is the exception — it is an input, applied by a human. | ||
|
|
||
| | Label | Meaning | | ||
| |-------|---------| | ||
| | `ready-for-review` | Workflow state marker on the PR. Applied by the [code agent](code.md) after pushing. In per-repo installs, triggers review when applied to a PR. | | ||
| | `ready-for-merge` | The review agent approved the PR. No blocking findings. | | ||
| | `requires-manual-review` | The review agent found issues that require human judgment — it could not confidently approve or reject. | | ||
| | `rejected` | The review agent rejected the PR and closed it. | | ||
| | `fullsend-no-review` | Prevents automatic review runs on this PR. Mirrors the [fix agent](fix.md)'s `fullsend-no-fix` label. Applied manually; explicit `/fs-review` commands are unaffected. | | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. MEDIUM — "Mirrors The new control-label row says Suggestion: Add |
||
|
|
||
| When the review agent requests changes (without rejecting), no outcome label is | ||
| applied — the `pull_request_review` event triggers the [fix agent](fix.md) directly. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
MEDIUM — Synchronize trigger bullet left unqualified while draft pushes are skipped
Line 20 gained "(drafts excluded — see below)" but line 21, "New commits are pushed to a PR/MR (synchronized)", was left with no caveat. Verified at #6587 head: the guard
if [[ "${EVENT_ACTION}" == "ready_for_review" || "${PR_IS_DRAFT}" != "true" ]]coversopened|synchronize|ready_for_review, so pushes to a draft are skipped exactly as opens are. A reader scanning only the Triggers list concludes that pushes to a draft still trigger a review — the precise misconception this PR exists to remove.Suggestion: Mirror the "(drafts excluded — see below)" qualifier on the synchronize bullet, or restructure so Triggers lists raw events and defers every exception to Automatic skips.