docs: add PR Review Fleet workflow README and design notes#27373
docs: add PR Review Fleet workflow README and design notes#27373tylerbutler wants to merge 1 commit into
Conversation
|
Hi! Thank you for opening this PR. Want me to review it? Based on the diff (155 lines, 2 files), I've queued these reviewers:
How this works
|
There was a problem hiding this comment.
Pull request overview
Adds documentation alongside the PR Review Fleet GitHub Actions workflows to explain how the fleet system is triggered, routed, and secured (including the pull_request vs pull_request_target rationale and the credential/prompt-isolation invariants).
Changes:
- Add a workflow reference README describing the four fleet workflows, their triggers/permissions, sizing thresholds, end-to-end flows, and security invariants.
- Add design notes explaining the security tradeoffs of
pull_requestvspull_request_targetas applied to this pipeline.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| .github/workflows/pr-review-fleet.README.md | Reference documentation for the fleet review workflow system (triggers, permissions, flow, security invariants). |
| .github/workflows/pr-review-fleet.design-notes.md | Design/security notes for choosing pull_request vs pull_request_target in this pipeline. |
|
|
||
| ## 1. `pr-review-auto-route.yml` — Sizer + Proposal | ||
|
|
||
| - **Trigger:** `pull_request_target` on `opened` / `reopened` / `synchronize` (base branches `main`, `next`, `release/**`). |
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
Adds two docs alongside the fleet review workflows in
.github/workflows/:pr-review-fleet.README.md— reference for the four workflows that compose the fleet review system (pr-review-auto-route,pr-review-confirm,pr-review-dispatch,pr-review-fleet). Covers triggers, permissions, sizing thresholds, end-to-end flows for both the auto-route and label paths, and per-workflow security invariants.pr-review-fleet.design-notes.md— design discussion ofpull_requestvspull_request_targetas applied to this pipeline. Covers why the auto-router can safely run onpull_request_target(never checks out PR head), how the fleet workflow isolates the credentialed Copilot agent from git (no shell tools +persist-credentials: false+ prompt loaded from base branch), output scrubbing as defense-in-depth, theactions: writerequirement on the confirm workflow, and existing actor-permission checks.Docs-only. No workflow behavior changes.