Repository navigation
docs: fix gh-aw guide — correct git add paths, demote compile step, add restricted-secrets callout - #1776
Conversation
…dd restricted-secrets callout - git add command corrected: .github/aw/ does not exist; gh aw add writes to .github/workflows/ and .github/skills/. Updated in Quick Start and Setup. - Removed standalone gh aw compile step (Quick Start 6→5 steps; Setup section renamed to troubleshooting note). Lock files are generated by gh aw add. Upgrading section reference preserved — correct there. - Added restricted-secrets approval callout in Setup after gh aw add block, with --approve flag workaround. Verified paths by running gh aw add in a scratch git repo in TEMP. Closes #1761 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
🟡 Impact Analysis — PR #1776Risk tier: 🟡 MEDIUM 📊 Summary
🎯 Risk Factors
📦 Modules Affecteddocs (1 file)
squad-state (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 | 1 commit — clean history |
| ✅ | 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 merge conflicts | No merge conflicts |
| ❌ | Copilot threads resolved | 3 unresolved Copilot thread(s) — fix and resolve before merging |
| ✅ | CI passing | All checks passing |
Files Changed (2 files, +43 −23)
| File | +/− |
|---|---|
.squad/agents/pao/history.md |
+15 −0 |
docs/src/content/docs/guide/gh-aw.md |
+28 −23 |
Total: +43 −23
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.
Pull request overview
This PR corrects the GitHub Agentic Workflows (gh aw) setup guide to reflect the actual files created by gh aw add, remove a redundant manual compile step, and document the restricted-secrets approval prompt—reducing the chance of misleading setup guidance and false E2E failures.
Changes:
- Fixes the documented
git addpaths in Quick start and Setup to stage.github/workflows/and.github/skills/(instead of.github/aw/). - Demotes
gh aw compilefrom a required setup step to a troubleshooting-only action, while keeping the upgrade reference intact. - Adds a restricted-secrets prompt callout (with
--approve) and records the work in PAO agent history.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/guide/gh-aw.md | Updates setup instructions: correct staged paths, removes standalone compile step, adds restricted-secrets prompt guidance, and adjusts related explanatory text. |
| .squad/agents/pao/history.md | Adds a dated history entry documenting verification and the doc corrections made for issue #1761. |
Review details
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 2/2 changed files
- Comments generated: 3
- Review effort level: Lite
| This stages everything `gh aw add` wrote — workflow source files and their | ||
| compiled `.lock.yml` files under `.github/workflows/`, the agentic-workflows | ||
| skill under `.github/skills/`, and the `.gitattributes` entry that marks lock | ||
| files as generated. No need to update this command as Squad's shipped files | ||
| evolve. |
| Downloaded workflow audit data is local diagnostic output and should not be | ||
| committed. If a `.gitignore` is missing from your workflow logs directory, add: | ||
|
|
| 2. **`gh aw compile` demoted** from required step to troubleshooting note. Quick Start reduced from 6 to 5 steps. Lock files are generated automatically by `gh aw add`. Upgrading section left unchanged (correct there). | ||
| 3. **Restricted secrets callout added** in Setup immediately after the `gh aw add` block, with `--approve` flag workaround. | ||
|
|
||
| **Decision record:** `.squad/decisions/inbox/pao-1761-gh-aw-path-verification.md` |
Summary
Fixes three errors in the GitHub Agentic Workflows guide that could cause false E2E test failures.
Verification: the
.github/aw/path questionMethod: Created a scratch
git initrepo in$env:TEMP, rangh aw add bradygaster/squad/workflows/squad-implement-worker.md@dev bradygaster/squad/workflows/squad.md@dev, and inspected every path created. Cleaned up afterward.Result:
.github/aw/is not created bygh aw add. The actual paths are:Changes
1.
git addpath corrected (Quick Start + Setup)Before:
After:
2. Standalone
gh aw compilestep removedLock files are generated automatically by
gh aw add. The required compile step in Quick Start (6→5 steps) and the "Compile to lock files" section in Setup are removed. A troubleshooting note replaces the section. The Upgrading section reference is preserved — it is correct there.3. Restricted secrets callout added
gh aw addshows a safe-update-mode warning forSQUAD_GITHUB_APP_PRIVATE_KEYandSQUAD_GITHUB_TOKEN. Added a callout with the--approveflag workaround immediately after thegh aw addblock in Setup.What was NOT touched
/squad reviewsection) — left alone per instructions (Phase 4: Ship /squad review in gh aw add and update the gh-aw guide #1736 deferred)gh aw compilereference — preserved, correct thereCloses #1761