chore(gh-aw): add gh aw init tooling (skills, MCP, setup + maintenance workflows) - #1592
chore(gh-aw): add gh aw init tooling (skills, MCP, setup + maintenance workflows)#1592bradygaster wants to merge 2 commits into
Conversation
🛫 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 (3 outdated skipped) |
| ❌ | CI passing | 1 check(s) failing: test |
Files Changed (6 files, +1372 −0)
| File | +/− |
|---|---|
.github/agents/agentic-workflows.md |
+226 −0 |
.github/mcp.json |
+20 −0 |
.github/skills/agentic-workflow-designer/SKILL.md |
+390 −0 |
.github/skills/agentic-workflows/SKILL.md |
+96 −0 |
.github/workflows/agentics-maintenance.yml |
+614 −0 |
.github/workflows/copilot-setup-steps.yml |
+26 −0 |
Total: +1372 −0
This check runs automatically on every push. Fix any ❌ items and push again.
See CONTRIBUTING.md and PR Requirements for details.
🔒 Security Review🔒 Security review: 6 warning(s), 18 info.
Automated security review — informational only. |
🟡 Impact Analysis — PR #1592Risk tier: 🟡 MEDIUM 📊 Summary
🎯 Risk Factors
📦 Modules Affectedci-workflows (6 files)
This report is generated automatically for every PR. See #733 for details. |
🏗️ Architectural Review
Automated architectural review — informational only. |
There was a problem hiding this comment.
🟡 Not ready to approve
There are a few concrete correctness/convention issues in newly added dispatcher docs/skills and workflow action pinning that should be fixed before merge.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
Adds the standard gh aw init scaffolding needed for authoring/publishing GitHub Agentic Workflows in this repo, including Copilot cloud-agent setup, gh-aw maintenance automation, and routing skills/agents.
Changes:
- Adds a Copilot setup-steps workflow to install
gh-awin CI/agent environments. - Adds the generated gh-aw maintenance workflow to close expiring entities and support manual maintenance operations.
- Adds gh-aw dispatcher assets: skills (
agentic-workflows,agentic-workflow-designer), an authoring sub-agent, and a cloud-agent MCP config.
File summaries
| File | Description |
|---|---|
| .github/workflows/copilot-setup-steps.yml | Adds Copilot setup-steps job to install gh-aw tooling. |
| .github/workflows/agentics-maintenance.yml | Adds generated scheduled/manual maintenance workflow for gh-aw entities. |
| .github/skills/agentic-workflows/SKILL.md | Adds router/dispatcher skill for gh-aw workflow tasks. |
| .github/skills/agentic-workflow-designer/SKILL.md | Adds interactive workflow-design interview skill. |
| .github/mcp.json | Adds cloud-agent MCP server config for gh-aw commands. |
| .github/agents/agentic-workflows.md | Adds gh-aw dispatcher sub-agent documentation and routing guidance. |
Review details
- Files reviewed: 6/6 changed files
- Comments generated: 3
- Review effort level: Lite
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
| - name: Checkout repository | ||
| uses: actions/checkout@v6 |
| ## Important Notes | ||
|
|
||
| - Always reference the instructions file at `https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/github-agentic-workflows.md` for complete documentation | ||
| - Use the MCP tool `agentic-workflows` when running in GitHub Copilot Cloud |
| - Choose workflow architecture and patterns: `.github/aw/patterns.md` | ||
| - Optimize token usage and cost: `.github/aw/token-optimization.md` | ||
|
|
||
| When the task involves OTEL, OTLP, traces, observability backends, or telemetry-driven analysis, also read and follow `skills/otel-queries/SKILL.md` after loading the matching workflow prompt or skill. |
) * fix(ci): skip DO-NOT-EDIT gh-aw generated workflows in lint; widen agents guard actionlint v1.7.12 is the current latest release — upgrading cannot fix this. The tool lags GitHub's evolving feature set on two specific constructs: • 'copilot-requests: write' — a real current Actions permission scope used by GitHub's own gh-aw toolchain. • 'concurrency.queue: max' — a newer Actions concurrency feature. The files triggering these errors are DO-NOT-EDIT compiler output from gh-aw's 'gh aw compile' toolchain (*.lock.yml) and gh-aw's code generators (e.g. agentics-maintenance.yml). Editing them is not acceptable — they are clobbered on each compile/generate cycle and are validated upstream by gh-aw's own toolchain. Fix 1 (.github/workflows/squad-workflow-lint.yml): Detect generated files by their header ('automatically generated' / 'DO NOT EDIT' within the first 5 lines) and skip them. Header-based detection automatically covers future gh-aw generated files without manual maintenance. Hand-authored workflows are always linted. Verified with a sabotage test: intentionally broken hand-authored workflow still fails the gate. Skipped files are echoed in CI logs for debuggability. Fix 2 (test/template-sync.test.ts): The '.github/agents/ negative guard' asserted strict directory equality, which over-reaches. 'gh aw init' legitimately installs its own agentic-workflows.md in that directory. Narrowed the guard to its actual intent: squad.agent.md must be present, no *unexpected* files allowed, with an explicit allowlist of known non-Squad agents. A truly random stray file still fails the test. Unblocks PRs #1587 and #1592 (does NOT close them). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(test): add section-1 beforeAll sync to guard against init-scaffolding race test/init-scaffolding.test.ts runs runInit() from a subdirectory of the repo root. In monorepo mode the init command detects the git root and places squad.agent.md at .github/agents/ in the REAL repo root, then calls stampVersion() to rewrite that file in place. This runs concurrently with template-sync.test.ts in a different Vitest worker. The file-level beforeAll sync in template-sync.test.ts is correct but leaves a race window: if init-scaffolding's stampVersion write lands between the file-level sync and section 1's readFileBytes calls, the byte comparison sees the stamped file (which differs from the canonical) and fails. Fix: add a describe-scoped beforeAll inside section 1 that re-runs the sync immediately before the byte comparisons start. This collapses the race window from 'entire beforeAll + test-collection time' to near-zero. The byte-for-byte assertion itself is unchanged; this only makes the setup more resilient. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…e workflows) gh aw init had never been run in this repo; this adds the standard scaffolding gh-aw generates for a repository that authors and ships agentic workflows. We are now a gh-aw publisher (.github/workflows/shared/squad.md, squad-backlog-triage.md, aw.yml in PR #1587), so this tooling protects the correctness of what we ship: - .github/skills/agentic-workflows/ and agentic-workflow-designer/: designer / dispatcher skills that keep gh-aw frontmatter and compiled .lock.yml correct. - .github/agents/agentic-workflows.md: the gh-aw authoring sub-agent. - .github/workflows/copilot-setup-steps.yml: lets @copilot run 'gh aw compile' in CI rather than hand-editing generated .lock.yml files. - .github/workflows/agentics-maintenance.yml: REQUIRED because squad-backlog-triage.md uses 'expires: 7' — this workflow closes the gh-aw-created expiring issues/PRs/discussions. - .github/mcp.json: configures the gh-aw MCP server for the CLOUD coding agent. The local-CLI equivalent lives in root .mcp.json and is intentionally NOT included here. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Pin actions/checkout to SHA (supply-chain hardening) - Fix MCP tool name: agentic-workflows → github-agentic-workflows - Remove reference to non-existent skills/otel-queries/SKILL.md Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
88d34c8 to
dcdad08
Compare
What
gh aw inithad never been run in this repository. This PR adds the standard scaffolding thatgh aw initgenerates for a repo that authors and ships GitHub Agentic Workflows, as its own reviewable change — separate from the gh-aw shared-component work in #1587.Why
We are now a gh-aw publisher: we ship
.github/workflows/shared/squad.md,.github/workflows/squad-backlog-triage.md, and a rootaw.ymlpackage manifest (all in #1587). This tooling exists to keep what we publish correct:.github/skills/agentic-workflows/SKILL.md+.github/skills/agentic-workflow-designer/SKILL.md— the gh-aw designer/dispatcher skills. Because we ship gh-aw workflows, these protect frontmatter validity and compiled.lock.ymlcorrectness..github/agents/agentic-workflows.md— the gh-aw authoring sub-agent..github/workflows/copilot-setup-steps.yml— lets @copilot rungh aw compilein CI rather than hand-editing generated.lock.ymlfiles (which must never be edited by hand)..github/workflows/agentics-maintenance.yml— required, not gratuitous:squad-backlog-triage.md(line 30,expires: 7) creates expiring entities, and this workflow is what closes them..github/mcp.json— configures the gh-aw MCP server for the cloud coding agent. The local-CLI equivalent lives in root.mcp.jsonand is intentionally NOT included in this PR.agentics-maintenance.ymlruns daily at cron37 0 * * *and holds write permissions:issues: writepull-requests: writediscussions: writeThese are scoped to closing the gh-aw-created expiring entities (driven by the minimum
expires: 7in our triage workflow), but the daily cadence + write scope are called out explicitly so this can be weighed before merge.Notes for reviewers
agentic-*skills were staged explicitly by full path. The rest of.github/skills/(Squad's owncoordinator-*,cross-squad,reflect, etc.) is currently untracked in the working tree and was deliberately left out of this PR — flagging so it can be decided separately.aw.ymlis not in this PR — it belongs to feat(gh-aw): add Squad shared component for GitHub Agentic Workflows #1587.gh aw compilereports no workflow markdown files on thisdev-based branch, because the workflows/shared component/manifest live in feat(gh-aw): add Squad shared component for GitHub Agentic Workflows #1587; these 6 tooling files are scaffolding and are not themselves compiled.npx vitest run test/docs-build.test.tspasses (22/22).