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
Copy file name to clipboardExpand all lines: .github/agents/agentic-workflows.agent.md
+58-11Lines changed: 58 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,12 @@ This is a **dispatcher agent** that routes your request to the appropriate speci
19
19
-**Creating shared components**: Routes to `create-shared-agentic-workflow` prompt
20
20
-**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
21
-**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
22
+
-**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
+
-**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
+
-**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
+
26
+
> [!IMPORTANT]
27
+
> For architecture/pattern-selection requests, load `https://github.com/github/gh-aw/blob/v0.74.2/.github/aw/patterns.md` first.
22
28
23
29
Workflows may optionally include:
24
30
@@ -30,7 +36,7 @@ Workflows may optionally include:
30
36
- Workflow files: `.github/workflows/*.md` and `.github/workflows/**/*.md`
@@ -92,7 +98,7 @@ When you interact with this agent, it will:
92
98
### Create a Report-Generating Workflow
93
99
**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"
@@ -112,7 +118,7 @@ When you interact with this agent, it will:
112
118
### Fix Dependabot PRs
113
119
**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"
@@ -122,13 +128,48 @@ When you interact with this agent, it will:
122
128
### Analyze Test Coverage
123
129
**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"
129
135
- "Analyze coverage trends over time"
130
136
- "Add a coverage gate that blocks PRs below a threshold"
131
137
138
+
### CLI Commands Reference
139
+
**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?"
145
+
- "What's the MCP equivalent of `gh aw logs`?"
146
+
- "I'm in Copilot Cloud — how do I compile a workflow?"
147
+
- "Show me all available gh aw commands"
148
+
149
+
### Token Consumption Optimization
150
+
**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?"
169
+
- "How should I structure this workflow architecture?"
170
+
- "What pattern fits slash-command triage?"
171
+
- "Should this be DispatchOps or DailyOps?"
172
+
132
173
## Instructions
133
174
134
175
When a user interacts with you:
@@ -147,6 +188,10 @@ gh aw init
147
188
# Generate the lock file for a workflow
148
189
gh aw compile [workflow-name]
149
190
191
+
# Trigger a workflow on demand (preferred over gh workflow run)
192
+
gh aw run <workflow-name># interactive input collection
193
+
gh aw run <workflow-name> --ref main # run on a specific branch
194
+
150
195
# Debug workflow runs
151
196
gh aw logs [workflow-name]
152
197
gh aw audit <run-id>
@@ -169,10 +214,12 @@ gh aw compile --validate
169
214
170
215
## Important Notes
171
216
172
-
- Always reference the instructions file at https://github.com/github/gh-aw/blob/v0.65.6/.github/aw/github-agentic-workflows.md for complete documentation
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
173
218
- Use the MCP tool `agentic-workflows` when running in GitHub Copilot Cloud
174
219
- Workflows must be compiled to `.lock.yml` files before running in GitHub Actions
175
220
-**Bash tools are enabled by default** - Don't restrict bash commands unnecessarily since workflows are sandboxed by the AWF
176
221
- Follow security best practices: minimal permissions, explicit network access, no template injection
177
-
-**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.65.6/.github/aw/network.md for the full list of valid ecosystem identifiers and domain patterns.
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.
178
223
-**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
+
-**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
0 commit comments