docs(gh-aw): ship advisory review - #1874
Conversation
Closes #1736 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
🟡 Impact Analysis — PR #1874Risk tier: 🟡 MEDIUM 📊 Summary
🎯 Risk Factors
📦 Modules Affectedci-workflows (1 file)
docs (2 files)
root (2 files)
tests (1 file)
This report is generated automatically for every PR. See #733 for details. |
🛫 PR Readiness Check
PR Scope: 🔧 Infrastructure
|
| Status | Check | Details |
|---|---|---|
| ❌ | Single commit | 2 commits — consider squashing before review |
| ✅ | Not in draft | Ready for review |
| ✅ | Branch up to date | Up to date with dev |
| ❌ | Copilot review | No Copilot review yet — it may still be processing |
| ✅ | Changeset present | No source files changed — changeset not required |
| ✅ | Scope clean | No .squad/ or docs/proposals/ files |
| ✅ | No merge conflicts | No merge conflicts |
| ✅ | Copilot threads resolved | 0 active Copilot thread(s) resolved (2 outdated skipped) |
| ❌ | CI passing | 10 check(s) still running |
Files Changed (6 files, +176 −43)
| File | +/− |
|---|---|
.github/agents.md |
+10 −6 |
README.md |
+5 −2 |
docs/demo-agentic-sdlc-walkthrough.md |
+1 −1 |
docs/src/content/docs/guide/gh-aw.md |
+71 −32 |
test/gh-aw-review-workflow.test.ts |
+85 −1 |
workflows/shared/squad.md |
+4 −1 |
Total: +176 −43
This check runs automatically on every push. Fix any ❌ items and push again.
See CONTRIBUTING.md and PR Requirements for details.
There was a problem hiding this comment.
🟡 Changes recommended
There are documentation inconsistencies around whether gh aw compile is required vs only needed for troubleshooting/safe-update-mode approval, which could confuse installers across the different install surfaces.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates the gh-aw installation and documentation surfaces to ship and describe the new advisory /squad review workflow alongside the dispatcher and implementation worker, and adds regression tests to keep install ordering and documentation assertions consistent over time.
Changes:
- Updates all “consumer install surfaces” to a consistent
gh aw addordering: dispatcher first, then implement worker, then advisory reviewer. - Replaces the “review gap” documentation with the actual advisory review lifecycle, provenance rules, verdict semantics, and “human approval remains mandatory” guidance.
- Adds tests to enforce the three-workflow install order across docs/README/shared bootstrap and to validate the six-file source/lock output.
File summaries
| File | Description |
|---|---|
| workflows/shared/squad.md | Updates distribution bootstrap comments to reflect the three-workflow install sequence. |
| test/gh-aw-review-workflow.test.ts | Adds install-surface/order regression checks and validates install produces complete source+lock pairs. |
| README.md | Updates the installation snippet to include the advisory reviewer in the gh aw add list. |
| docs/src/content/docs/guide/gh-aw.md | Updates install instructions and fully documents the advisory review lifecycle and semantics. |
| docs/demo-agentic-sdlc-walkthrough.md | Updates demo prerequisite to reference the new multi-workflow install path. |
| .github/agents.md | Updates agent-facing installation docs to include dispatcher + worker + reviewer. |
Review details
- Files reviewed: 6/6 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Closes #1736 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
…ows (#1886) - Pin gh-aw to v0.86.2 in the \ est\ job so compiler version is deterministic across runs (was unpinned with \gh extension install\). - Add \gh-aw-compile\ job that strict-compiles squad, squad-implement-worker, squad-review, and squad-deps-worker on every PR and push. Failures accumulate before exit so all four results are visible in one run. A compiler that exits 0 without emitting a lock file also fails the gate (silent-success is a gate gap). Same v0.86.2 pin used in both jobs. Required-check setup (external, cannot be enforced from repo code): Enable ruleset 12703724, add refs/heads/dev and refs/heads/main, require \Squad CI / gh-aw strict compile\ and \Squad CI / test\. Addresses: gh-aw version non-determinism and the missing dedicated compile gate that allowed #1873 and #1874 to merge with failing checks. Co-authored-by: brady gaster <bradygaster@github.com> Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Summary
gh aw adddispatcher first and include the implementation worker plus advisory reviewer across every consumer install surface/squad reviewtriggers, provenance priority, SHA deduplication, advisory verdicts, reviewer independence, mandatory human approval, and the advisory fast-path tradeoffInstall result
The dispatcher-first command installs these top-level pairs:
squad.md+squad.lock.ymlsquad-implement-worker.md+squad-implement-worker.lock.ymlsquad-review.md+squad-review.lock.ymlValidation
gh aw addsmoke produced the exact six-file setvitest@4.1.11andsatteri@0.10.5; manifests and lockfiles are unchangedWorking as PAO (DevRel).
Closes #1736