Skip to content

docs: fix gh-aw guide — correct git add paths, demote compile step, add restricted-secrets callout - #1776

Merged
bradygaster merged 1 commit into
devfrom
bradygaster-pao-fix-gh-aw-guide-1761
Aug 20, 2026
Merged

bradygaster merged 1 commit into
devfrom
bradygaster-pao-fix-gh-aw-guide-1761

Conversation

@bradygaster

Copy link
Copy Markdown
Collaborator

Summary

Fixes three errors in the GitHub Agentic Workflows guide that could cause false E2E test failures.

Verification: the .github/aw/ path question

Method: Created a scratch git init repo in $env:TEMP, ran gh 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 by gh aw add. The actual paths are:

.gitattributes
.github/skills/agentic-workflows/SKILL.md
.github/workflows/squad.md
.github/workflows/squad.lock.yml
.github/workflows/squad-implement-worker.md
.github/workflows/squad-implement-worker.lock.yml
.github/workflows/shared/squad.md
.github/workflows/shared/squad-planning-ontology.md
.github/workflows/shared/squad-planning-policy.md
.vscode/settings.json

Changes

1. git add path corrected (Quick Start + Setup)

Before:

git add -- .gitattributes .github/aw/ .github/workflows/

After:

git add -- .gitattributes .github/workflows/ .github/skills/

2. Standalone gh aw compile step removed

Lock 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 add shows a safe-update-mode warning for SQUAD_GITHUB_APP_PRIVATE_KEY and SQUAD_GITHUB_TOKEN. Added a callout with the --approve flag workaround immediately after the gh aw add block in Setup.

What was NOT touched

Closes #1761

…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>
Copilot AI lite review requested due to automatic review settings August 20, 2026 19:49
@github-actions

Copy link
Copy Markdown
Contributor

🟡 Impact Analysis — PR #1776

Risk tier: 🟡 MEDIUM

📊 Summary

Metric Count
Files changed 2
Files added 0
Files modified 2
Files deleted 0
Modules touched 2

🎯 Risk Factors

  • 2 files changed (≤5 → LOW)
  • 2 modules touched (2-4 → MEDIUM)

📦 Modules Affected

docs (1 file)
  • docs/src/content/docs/guide/gh-aw.md
squad-state (1 file)
  • .squad/agents/pao/history.md

This report is generated automatically for every PR. See #733 for details.

@github-actions

github-actions Bot commented Aug 20, 2026 •

Copy link
Copy Markdown
Contributor

🛫 PR Readiness Check

ℹ️ This comment updates on each push. Last checked: commit 0c945d7

PR Scope: 🔧 Infrastructure

⚠️ 2 item(s) to address before review

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 ⚠️ PR includes 1 .squad/ file(s) — ensure these are intentional
✅ 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.

@github-actions

Copy link
Copy Markdown
Contributor

⚠️ Squad File Leakage Detected

The following .squad/ files were modified in this PR:

  • .squad/agents/pao/history.md

These files affect team routing, agent charters, and decisions.
If intentional, ensure approval from the team lead.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 add paths in Quick start and Setup to stage .github/workflows/ and .github/skills/ (instead of .github/aw/).
  • Demotes gh aw compile from 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

Comment on lines +116 to +120
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.
Comment on lines +126 to 128
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`
@bradygaster
bradygaster merged commit d24a322 into dev Aug 20, 2026
16 checks passed
@bradygaster
bradygaster deleted the bradygaster-pao-fix-gh-aw-guide-1761 branch September 9, 2026 19:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix three errors in the gh-aw guide

2 participants