Repository navigation
Commit 88b4550
docs(gh-aw): fix setup guide contradictions and sync enlistment guidance (#2153)
Resolve a set of contradictions/unreliable instructions in the public
Agentic Workflows setup guide (docs/src/content/docs/guide/gh-aw.md):
- Clarify the Profile A (least-privilege, recommended) Actions
permission setting and what remains manual under it; add an explicit
opt-in Profile B (automatic PR creation) section with its coupled
security tradeoff instead of silently enabling it.
- Remove unconditional safe-update approval from the executable quick
start; approval now requires verifying the report contains exactly
SQUAD_GITHUB_APP_PRIVATE_KEY, SQUAD_GITHUB_TOKEN, and
bradygaster/squad/.github/actions/squad-init, otherwise stop.
- Replace the broken `gh pr edit --add-reviewer @copilot` with a
verified Copilot-as-Bot GraphQL requestReviewsByLogin/botLogins
request plus a manual UI fallback (both quick-start and full-steps
flows).
- Make SQUAD_SHA discovery immutable: remove prose claiming quick
start resolves dev automatically; require a maintainer-approved SHA.
- Make quick start rerunnable/safe: validate a clean working tree and
reuse an existing bootstrap branch instead of failing.
- Replace the incomplete 7/8-workflow, 5/17-runtime-resource inventory
loop with the manifest-backed squad-install-verifier.mjs
--verify-install check (8 workflows / 17 shared runtime resources).
- Correct the least-privilege fallback lifecycle: bootstrap opens/
reuses a signed fallback issue, a human opens the Cast PR, and Squad
Bootstrap must be manually re-dispatched to create the linked
research-proposal issue; make this explicit in the quick-start
outcome narrative.
- Align the /squad implement and troubleshooting prose with the
Profile A/B framing so it no longer recommends disabling PR creation
while also claiming automatic implementation PRs.
Sync the canonical enlistment guidance
(.squad-templates/skills/gh-aw-enlistment/SKILL.md) and its 4 mirrors
with the same Copilot-as-Bot GraphQL reviewer-request fix (verified
via scripts/sync-templates.mjs --sync), and regenerate
workflows/squad-workflows.manifest.json's enlistment-skill digest via
squad-install-verifier.mjs --write-source.
Update the two directly-related documentation contract tests:
- test/gh-aw-enlistment-skill.test.ts: match the renamed Profile A
heading used as a test slice boundary.
- test/standalone-release-workflow.test.ts: assert the new
requestReviewsByLogin/copilot-pull-request-reviewer approach instead
of the removed --add-reviewer command.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>1 parent ebf1564 commit 88b4550
9 files changed
Lines changed: 262 additions & 60 deletions
File tree
- .squad-templates/skills/gh-aw-enlistment
- docs/src/content/docs/guide
- packages
- squad-cli/templates/skills/gh-aw-enlistment
- squad-sdk/templates/skills/gh-aw-enlistment
- templates/skills/gh-aw-enlistment
- test
- workflows
- skills/gh-aw-enlistment
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
382 | 382 | | |
383 | 383 | | |
384 | 384 | | |
385 | | - | |
| 385 | + | |
| 386 | + | |
| 387 | + | |
| 388 | + | |
| 389 | + | |
| 390 | + | |
| 391 | + | |
| 392 | + | |
| 393 | + | |
| 394 | + | |
| 395 | + | |
386 | 396 | | |
387 | 397 | | |
388 | 398 | | |
389 | 399 | | |
390 | 400 | | |
391 | | - | |
| 401 | + | |
| 402 | + | |
| 403 | + | |
| 404 | + | |
| 405 | + | |
392 | 406 | | |
393 | 407 | | |
394 | 408 | | |
| |||
497 | 511 | | |
498 | 512 | | |
499 | 513 | | |
500 | | - | |
| 514 | + | |
| 515 | + | |
| 516 | + | |
| 517 | + | |
| 518 | + | |
| 519 | + | |
| 520 | + | |
501 | 521 | | |
502 | 522 | | |
503 | 523 | | |
| |||
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
382 | 382 | | |
383 | 383 | | |
384 | 384 | | |
385 | | - | |
| 385 | + | |
| 386 | + | |
| 387 | + | |
| 388 | + | |
| 389 | + | |
| 390 | + | |
| 391 | + | |
| 392 | + | |
| 393 | + | |
| 394 | + | |
| 395 | + | |
386 | 396 | | |
387 | 397 | | |
388 | 398 | | |
389 | 399 | | |
390 | 400 | | |
391 | | - | |
| 401 | + | |
| 402 | + | |
| 403 | + | |
| 404 | + | |
| 405 | + | |
392 | 406 | | |
393 | 407 | | |
394 | 408 | | |
| |||
497 | 511 | | |
498 | 512 | | |
499 | 513 | | |
500 | | - | |
| 514 | + | |
| 515 | + | |
| 516 | + | |
| 517 | + | |
| 518 | + | |
| 519 | + | |
| 520 | + | |
501 | 521 | | |
502 | 522 | | |
503 | 523 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
382 | 382 | | |
383 | 383 | | |
384 | 384 | | |
385 | | - | |
| 385 | + | |
| 386 | + | |
| 387 | + | |
| 388 | + | |
| 389 | + | |
| 390 | + | |
| 391 | + | |
| 392 | + | |
| 393 | + | |
| 394 | + | |
| 395 | + | |
386 | 396 | | |
387 | 397 | | |
388 | 398 | | |
389 | 399 | | |
390 | 400 | | |
391 | | - | |
| 401 | + | |
| 402 | + | |
| 403 | + | |
| 404 | + | |
| 405 | + | |
392 | 406 | | |
393 | 407 | | |
394 | 408 | | |
| |||
497 | 511 | | |
498 | 512 | | |
499 | 513 | | |
500 | | - | |
| 514 | + | |
| 515 | + | |
| 516 | + | |
| 517 | + | |
| 518 | + | |
| 519 | + | |
| 520 | + | |
501 | 521 | | |
502 | 522 | | |
503 | 523 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
382 | 382 | | |
383 | 383 | | |
384 | 384 | | |
385 | | - | |
| 385 | + | |
| 386 | + | |
| 387 | + | |
| 388 | + | |
| 389 | + | |
| 390 | + | |
| 391 | + | |
| 392 | + | |
| 393 | + | |
| 394 | + | |
| 395 | + | |
386 | 396 | | |
387 | 397 | | |
388 | 398 | | |
389 | 399 | | |
390 | 400 | | |
391 | | - | |
| 401 | + | |
| 402 | + | |
| 403 | + | |
| 404 | + | |
| 405 | + | |
392 | 406 | | |
393 | 407 | | |
394 | 408 | | |
| |||
497 | 511 | | |
498 | 512 | | |
499 | 513 | | |
500 | | - | |
| 514 | + | |
| 515 | + | |
| 516 | + | |
| 517 | + | |
| 518 | + | |
| 519 | + | |
| 520 | + | |
501 | 521 | | |
502 | 522 | | |
503 | 523 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
497 | 497 | | |
498 | 498 | | |
499 | 499 | | |
500 | | - | |
| 500 | + | |
501 | 501 | | |
502 | 502 | | |
503 | 503 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
703 | 703 | | |
704 | 704 | | |
705 | 705 | | |
706 | | - | |
| 706 | + | |
| 707 | + | |
707 | 708 | | |
708 | 709 | | |
709 | 710 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
382 | 382 | | |
383 | 383 | | |
384 | 384 | | |
385 | | - | |
| 385 | + | |
| 386 | + | |
| 387 | + | |
| 388 | + | |
| 389 | + | |
| 390 | + | |
| 391 | + | |
| 392 | + | |
| 393 | + | |
| 394 | + | |
| 395 | + | |
386 | 396 | | |
387 | 397 | | |
388 | 398 | | |
389 | 399 | | |
390 | 400 | | |
391 | | - | |
| 401 | + | |
| 402 | + | |
| 403 | + | |
| 404 | + | |
| 405 | + | |
392 | 406 | | |
393 | 407 | | |
394 | 408 | | |
| |||
497 | 511 | | |
498 | 512 | | |
499 | 513 | | |
500 | | - | |
| 514 | + | |
| 515 | + | |
| 516 | + | |
| 517 | + | |
| 518 | + | |
| 519 | + | |
| 520 | + | |
501 | 521 | | |
502 | 522 | | |
503 | 523 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
225 | 225 | | |
226 | 226 | | |
227 | 227 | | |
228 | | - | |
| 228 | + | |
229 | 229 | | |
230 | 230 | | |
231 | 231 | | |
| |||
0 commit comments