Skip to content

Commit 53a2c1d

Browse files
committed
Install Goal workflow
1 parent 61dd3d4 commit 53a2c1d

13 files changed

Lines changed: 3973 additions & 50 deletions

File tree

.github/ISSUE_TEMPLATE/goal.yml

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
name: Goal
2+
description: Create a verifiable Goal workflow issue
3+
title: "[Goal] "
4+
labels:
5+
- goal
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Use this form for one coherent Goal workflow objective with a clear stopping condition.
11+
12+
A good goal is bigger than one prompt but smaller than an open-ended backlog. It should tell the workflow what to do, what not to change, how to prove progress, and when to stop as blocked instead of guessing.
13+
14+
If the goal needs a helper script, fixture, package script, CI target, or other setup before doneness can be judged, ask an agent to use `new-goal.md` first and create the setup PR before submitting this form.
15+
16+
- type: input
17+
id: goal
18+
attributes:
19+
label: Goal
20+
description: State the desired end state in one sentence.
21+
placeholder: "Migrate tests/auth from legacyAuthHelper to createTestSession."
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: completion-contract
27+
attributes:
28+
label: Completion Contract
29+
description: Define exactly when Goal should add `goal-completed` and remove `goal`.
30+
placeholder: |
31+
Goal is complete only when:
32+
- Every test in tests/auth uses createTestSession.
33+
- legacyAuthHelper has no remaining call sites in tests/auth.
34+
- The auth test suite and lint pass.
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: evidence
40+
attributes:
41+
label: Evidence / Verification
42+
description: List the commands, scripts, artifacts, screenshots, logs, or checks that prove the completion contract.
43+
placeholder: |
44+
Run from the repository root:
45+
46+
```bash
47+
set -euo pipefail
48+
npm test -- tests/auth
49+
npm run lint
50+
! rg "legacyAuthHelper" tests/auth
51+
```
52+
53+
Completion requires every command to exit 0.
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
id: doneness-script
59+
attributes:
60+
label: Optional Inline Doneness Script
61+
description: If a compact script can judge completion, put it here. Prefer an inline script over a setup PR when it only calls existing repo commands.
62+
render: bash
63+
placeholder: |
64+
set -euo pipefail
65+
npm test -- tests/auth
66+
npm run lint
67+
! rg "legacyAuthHelper" tests/auth
68+
validations:
69+
required: false
70+
71+
- type: textarea
72+
id: scope
73+
attributes:
74+
label: Scope and Constraints
75+
description: Say what the workflow may change and what must not change or regress.
76+
placeholder: |
77+
The workflow may change:
78+
- tests/auth/**
79+
- test/helpers/auth.ts
80+
81+
The workflow must not change:
82+
- production authentication behavior
83+
- public API names
84+
- payment provider configuration
85+
validations:
86+
required: true
87+
88+
- type: textarea
89+
id: context
90+
attributes:
91+
label: Context To Read First
92+
description: Point the workflow at the files, docs, issues, PRs, logs, designs, references, or examples it should inspect before changing code.
93+
placeholder: |
94+
- tests/auth/session.test.ts
95+
- test/helpers/auth.ts
96+
- docs/testing/auth.md
97+
- #123
98+
validations:
99+
required: true
100+
101+
- type: textarea
102+
id: iteration-policy
103+
attributes:
104+
label: Iteration Policy
105+
description: Explain how the workflow should choose each next checkpoint and report progress.
106+
placeholder: |
107+
Work in one coherent test group at a time. After each run, report what changed, what was verified, what remains, and whether anything is blocked. Prefer the smallest next checkpoint that can be validated with the evidence above.
108+
validations:
109+
required: true
110+
111+
- type: textarea
112+
id: blocked-stop-condition
113+
attributes:
114+
label: Blocked Stop Condition
115+
description: Define when the workflow should stop substantive work and comment instead of guessing.
116+
placeholder: |
117+
Stop and comment if tests require unavailable secrets, fixtures, product decisions, or external services. The blocked comment should include the exact command output, what is known, and the smallest user action that would unblock the workflow.
118+
validations:
119+
required: true
120+
121+
- type: checkboxes
122+
id: readiness
123+
attributes:
124+
label: Ready To Start
125+
description: Submitting this form applies the `goal` label and may start the workflow.
126+
options:
127+
- label: This goal does not need a setup PR before the workflow starts.
128+
required: true
129+
- label: This is one coherent objective, not a loose backlog.
130+
required: true
131+
- label: The completion contract has observable evidence.
132+
required: true
133+
- label: The constraints are specific enough to prevent accidental broad rewrites.
134+
required: true
135+
- label: The workflow can tell the difference between done, not done yet, and blocked.
136+
required: true
Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
description: GitHub Agentic Workflows (gh-aw) - Create, debug, and upgrade AI-powered workflows with intelligent prompt routing
2+
name: Agentic Workflows
3+
description: GitHub Agentic Workflows (gh-aw) - Create, debug, and upgrade AI-powered workflows with intelligent prompt routing.
34
disable-model-invocation: true
45
---
56

@@ -13,19 +14,17 @@ This is a **dispatcher agent** that routes your request to the appropriate speci
1314

1415
- **Creating new workflows**: Routes to `create` prompt
1516
- **Updating existing workflows**: Routes to `update` prompt
16-
- **Debugging workflows**: Routes to `debug` prompt
17+
- **Debugging workflows**: Routes to `debug` prompt
1718
- **Upgrading workflows**: Routes to `upgrade-agentic-workflows` prompt
1819
- **Creating report-generating workflows**: Routes to `report` prompt — consult this whenever the workflow posts status updates, audits, analyses, or any structured output as issues, discussions, or comments
1920
- **Creating shared components**: Routes to `create-shared-agentic-workflow` prompt
2021
- **Fixing Dependabot PRs**: Routes to `dependabot` prompt — use this when Dependabot opens PRs that modify generated manifest files (`.github/workflows/package.json`, `.github/workflows/requirements.txt`, `.github/workflows/go.mod`). Never merge those PRs directly; instead update the source `.md` files and rerun `gh aw compile --dependabot` to bundle all fixes
2122
- **Analyzing test coverage**: Routes to `test-coverage` prompt — consult this whenever the workflow reads, analyzes, or reports on test coverage data from PRs or CI runs
23+
- **Rendering ASCII charts in markdown**: Routes to `asciicharts` guide — consult this whenever the workflow needs compact charts that render reliably in GitHub issues, comments, or discussions
2224
- **CLI commands and triggering workflows**: Routes to `cli-commands` guide — consult this whenever the user asks how to run, compile, debug, or manage workflows from the command line, or when they need the MCP tool equivalent of a `gh aw` command
2325
- **Reducing token consumption / cost optimization**: Routes to `token-optimization` guide — consult this whenever the user asks how to reduce token usage, lower costs, speed up workflows, or measure the impact of prompt changes with experiments
2426
- **Choosing workflow architectures and design patterns**: Routes to `patterns` guide — consult this whenever the user asks for strategy, architecture, operating models, or pattern selection for agentic workflows
2527

26-
> [!IMPORTANT]
27-
> For architecture/pattern-selection requests, load `https://github.com/github/gh-aw/blob/v0.74.2/.github/aw/patterns.md` first.
28-
2928
Workflows may optionally include:
3029

3130
- **Project tracking / monitoring** (GitHub Projects updates, status reporting)
@@ -36,7 +35,7 @@ Workflows may optionally include:
3635
- Workflow files: `.github/workflows/*.md` and `.github/workflows/**/*.md`
3736
- Workflow lock files: `.github/workflows/*.lock.yml`
3837
- Shared components: `.github/workflows/shared/*.md`
39-
- Configuration: https://github.com/github/gh-aw/blob/v0.74.2/.github/aw/github-agentic-workflows.md
38+
- Configuration: `.github/aw/github-agentic-workflows.md`
4039

4140
## Problems This Solves
4241

@@ -58,27 +57,27 @@ When you interact with this agent, it will:
5857
### Create New Workflow
5958
**Load when**: User wants to create a new workflow from scratch, add automation, or design a workflow that doesn't exist yet
6059

61-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.2/.github/aw/create-agentic-workflow.md
60+
**Prompt file**: `.github/aw/create-agentic-workflow.md`
6261

6362
**Use cases**:
6463
- "Create a workflow that triages issues"
6564
- "I need a workflow to label pull requests"
6665
- "Design a weekly research automation"
6766

68-
### Update Existing Workflow
67+
### Update Existing Workflow
6968
**Load when**: User wants to modify, improve, or refactor an existing workflow
7069

71-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.2/.github/aw/update-agentic-workflow.md
70+
**Prompt file**: `.github/aw/update-agentic-workflow.md`
7271

7372
**Use cases**:
7473
- "Add web-fetch tool to the issue-classifier workflow"
7574
- "Update the PR reviewer to use discussions instead of issues"
7675
- "Improve the prompt for the weekly-research workflow"
7776

78-
### Debug Workflow
77+
### Debug Workflow
7978
**Load when**: User needs to investigate, audit, debug, or understand a workflow, troubleshoot issues, analyze logs, or fix errors
8079

81-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.2/.github/aw/debug-agentic-workflow.md
80+
**Prompt file**: `.github/aw/debug-agentic-workflow.md`
8281

8382
**Use cases**:
8483
- "Why is this workflow failing?"
@@ -88,7 +87,7 @@ When you interact with this agent, it will:
8887
### Upgrade Agentic Workflows
8988
**Load when**: User wants to upgrade workflows to a new gh-aw version or fix deprecations
9089

91-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.2/.github/aw/upgrade-agentic-workflows.md
90+
**Prompt file**: `.github/aw/upgrade-agentic-workflows.md`
9291

9392
**Use cases**:
9493
- "Upgrade all workflows to the latest version"
@@ -98,7 +97,7 @@ When you interact with this agent, it will:
9897
### Create a Report-Generating Workflow
9998
**Load when**: The workflow being created or updated produces reports — recurring status updates, audit summaries, analyses, or any structured output posted as a GitHub issue, discussion, or comment
10099

101-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.2/.github/aw/report.md
100+
**Prompt file**: `.github/aw/report.md`
102101

103102
**Use cases**:
104103
- "Create a weekly CI health report"
@@ -108,7 +107,7 @@ When you interact with this agent, it will:
108107
### Create Shared Agentic Workflow
109108
**Load when**: User wants to create a reusable workflow component or wrap an MCP server
110109

111-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.2/.github/aw/create-shared-agentic-workflow.md
110+
**Prompt file**: `.github/aw/create-shared-agentic-workflow.md`
112111

113112
**Use cases**:
114113
- "Create a shared component for Notion integration"
@@ -118,7 +117,7 @@ When you interact with this agent, it will:
118117
### Fix Dependabot PRs
119118
**Load when**: User needs to close or fix open Dependabot PRs that update dependencies in generated manifest files (`.github/workflows/package.json`, `.github/workflows/requirements.txt`, `.github/workflows/go.mod`)
120119

121-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.2/.github/aw/dependabot.md
120+
**Prompt file**: `.github/aw/dependabot.md`
122121

123122
**Use cases**:
124123
- "Fix the open Dependabot PRs for npm dependencies"
@@ -128,7 +127,7 @@ When you interact with this agent, it will:
128127
### Analyze Test Coverage
129128
**Load when**: The workflow reads, analyzes, or reports test coverage — whether triggered by a PR, a schedule, or a slash command. Always consult this prompt before designing the coverage data strategy.
130129

131-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.2/.github/aw/test-coverage.md
130+
**Prompt file**: `.github/aw/test-coverage.md`
132131

133132
**Use cases**:
134133
- "Create a workflow that comments coverage on PRs"
@@ -138,7 +137,7 @@ When you interact with this agent, it will:
138137
### CLI Commands Reference
139138
**Load when**: The user asks how to run, compile, debug, or manage workflows from the command line; needs the MCP tool equivalent of a `gh aw` command; or is in a restricted environment (e.g., Copilot Cloud) without direct CLI access.
140139

141-
**Reference file**: https://github.com/github/gh-aw/blob/v0.74.2/.github/aw/cli-commands.md
140+
**Reference file**: `.github/aw/cli-commands.md`
142141

143142
**Use cases**:
144143
- "How do I trigger workflow X on the main branch?"
@@ -149,7 +148,7 @@ When you interact with this agent, it will:
149148
### Token Consumption Optimization
150149
**Load when**: The user asks how to reduce token usage, lower workflow costs, make a workflow faster or cheaper, or measure the impact of prompt or configuration changes.
151150

152-
**Reference file**: https://github.com/github/gh-aw/blob/v0.74.2/.github/aw/token-optimization.md
151+
**Reference file**: `.github/aw/token-optimization.md`
153152

154153
**Use cases**:
155154
- "How do I reduce the token cost of this workflow?"
@@ -162,7 +161,7 @@ When you interact with this agent, it will:
162161
### Workflow Pattern Selection
163162
**Load when**: The user asks for architecture, strategy, operating model selection, or pattern recommendations for building agentic workflows.
164163

165-
**Reference file**: https://github.com/github/gh-aw/blob/v0.74.2/.github/aw/patterns.md
164+
**Reference file**: `.github/aw/patterns.md`
166165

167166
**Use cases**:
168167
- "Which pattern should I use for multi-repo rollout?"
@@ -175,7 +174,7 @@ When you interact with this agent, it will:
175174
When a user interacts with you:
176175

177176
1. **Identify the task type** from the user's request
178-
2. **Load the appropriate prompt** from the GitHub repository URLs listed above
177+
2. **Load the appropriate prompt** from the repository paths listed above
179178
3. **Follow the loaded prompt's instructions** exactly
180179
4. **If uncertain**, ask clarifying questions to determine the right prompt
181180

@@ -214,12 +213,12 @@ gh aw compile --validate
214213

215214
## Important Notes
216215

217-
- Always reference the instructions file at https://github.com/github/gh-aw/blob/v0.74.2/.github/aw/github-agentic-workflows.md for complete documentation
216+
- Always reference the instructions file at `.github/aw/github-agentic-workflows.md` for complete documentation
218217
- Use the MCP tool `agentic-workflows` when running in GitHub Copilot Cloud
219218
- Workflows must be compiled to `.lock.yml` files before running in GitHub Actions
220219
- **Bash tools are enabled by default** - Don't restrict bash commands unnecessarily since workflows are sandboxed by the AWF
221220
- Follow security best practices: minimal permissions, explicit network access, no template injection
222-
- **Network configuration**: Use ecosystem identifiers (`node`, `python`, `go`, etc.) or explicit FQDNs in `network.allowed`. Bare shorthands like `npm` or `pypi` are **not** valid. See https://github.com/github/gh-aw/blob/v0.74.2/.github/aw/network.md for the full list of valid ecosystem identifiers and domain patterns.
221+
- **Network configuration**: Use ecosystem identifiers (`node`, `python`, `go`, etc.) or explicit FQDNs in `network.allowed`. Bare shorthands like `npm` or `pypi` are **not** valid. See `.github/aw/network.md` for the full list of valid ecosystem identifiers and domain patterns.
223222
- **Single-file output**: When creating a workflow, produce exactly **one** workflow `.md` file. Do not create separate documentation files (architecture docs, runbooks, usage guides, etc.). If documentation is needed, add a brief `## Usage` section inside the workflow file itself.
224223
- **Triggering runs**: Always use `gh aw run <workflow-name>` to trigger a workflow on demand — not `gh workflow run <file>.lock.yml`. `gh aw run` handles workflow resolution by short name, input parsing and validation, and correct run-tracking for agentic workflows. Use `--ref <branch>` to run on a specific branch.
225-
- **CLI commands reference**: For a complete guide on all `gh aw` commands and their MCP tool equivalents (for restricted environments), see https://github.com/github/gh-aw/blob/v0.74.2/.github/aw/cli-commands.md
224+
- **CLI commands reference**: For a complete guide on all `gh aw` commands and their MCP tool equivalents (for restricted environments), see `.github/aw/cli-commands.md`

.github/mcp.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"mcpServers": {
3+
"github-agentic-workflows": {
4+
"command": "gh",
5+
"args": ["aw", "mcp-server"]
6+
}
7+
}
8+
}

0 commit comments

Comments
 (0)