You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: .github/agents/agentic-workflows.md
+22-23Lines changed: 22 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,6 @@
1
1
---
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.
3
4
disable-model-invocation: true
4
5
---
5
6
@@ -13,19 +14,17 @@ This is a **dispatcher agent** that routes your request to the appropriate speci
13
14
14
15
-**Creating new workflows**: Routes to `create` prompt
15
16
-**Updating existing workflows**: Routes to `update` prompt
16
-
-**Debugging workflows**: Routes to `debug` prompt
17
+
-**Debugging workflows**: Routes to `debug` prompt
17
18
-**Upgrading workflows**: Routes to `upgrade-agentic-workflows` prompt
18
19
-**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
19
20
-**Creating shared components**: Routes to `create-shared-agentic-workflow` prompt
20
21
-**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
21
22
-**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
22
24
-**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
23
25
-**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
24
26
-**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
25
27
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
-
29
28
Workflows may optionally include:
30
29
31
30
-**Project tracking / monitoring** (GitHub Projects updates, status reporting)
@@ -36,7 +35,7 @@ Workflows may optionally include:
36
35
- Workflow files: `.github/workflows/*.md` and `.github/workflows/**/*.md`
@@ -98,7 +97,7 @@ When you interact with this agent, it will:
98
97
### Create a Report-Generating Workflow
99
98
**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
- "Create a shared component for Notion integration"
@@ -118,7 +117,7 @@ When you interact with this agent, it will:
118
117
### Fix Dependabot PRs
119
118
**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`)
- "Fix the open Dependabot PRs for npm dependencies"
@@ -128,7 +127,7 @@ When you interact with this agent, it will:
128
127
### Analyze Test Coverage
129
128
**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.
- "Create a workflow that comments coverage on PRs"
@@ -138,7 +137,7 @@ When you interact with this agent, it will:
138
137
### CLI Commands Reference
139
138
**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.
- "How do I trigger workflow X on the main branch?"
@@ -149,7 +148,7 @@ When you interact with this agent, it will:
149
148
### Token Consumption Optimization
150
149
**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.
- "Which pattern should I use for multi-repo rollout?"
@@ -175,7 +174,7 @@ When you interact with this agent, it will:
175
174
When a user interacts with you:
176
175
177
176
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
179
178
3.**Follow the loaded prompt's instructions** exactly
180
179
4.**If uncertain**, ask clarifying questions to determine the right prompt
181
180
@@ -214,12 +213,12 @@ gh aw compile --validate
214
213
215
214
## Important Notes
216
215
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
218
217
- Use the MCP tool `agentic-workflows` when running in GitHub Copilot Cloud
219
218
- Workflows must be compiled to `.lock.yml` files before running in GitHub Actions
220
219
-**Bash tools are enabled by default** - Don't restrict bash commands unnecessarily since workflows are sandboxed by the AWF
221
220
- 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.
223
222
-**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.
224
223
-**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`
0 commit comments