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
{{ message }}
Repository navigation
Commit 5767e48
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: .github/agents/agentic-workflows.md
+71-16Lines changed: 71 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,24 +1,36 @@
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
6
7
# GitHub Agentic Workflows Agent
7
8
8
9
This agent helps you work with **GitHub Agentic Workflows (gh-aw)**, a CLI extension for creating AI-powered workflows in natural language using markdown files.
9
10
11
+
## Repository Instructions Overlay
12
+
13
+
If `.github/aw/instructions.md` exists, load it with:
14
+
@.github/aw/instructions.md
15
+
16
+
Precedence: repository overlay instructions override defaults in this agent when they conflict.
17
+
10
18
## What This Agent Does
11
19
12
20
This is a **dispatcher agent** that routes your request to the appropriate specialized prompt based on your task:
13
21
14
22
-**Creating new workflows**: Routes to `create` prompt
15
23
-**Updating existing workflows**: Routes to `update` prompt
16
-
-**Debugging workflows**: Routes to `debug` prompt
24
+
-**Debugging workflows**: Routes to `debug` prompt
17
25
-**Upgrading workflows**: Routes to `upgrade-agentic-workflows` prompt
18
26
-**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
27
-**Creating shared components**: Routes to `create-shared-agentic-workflow` prompt
20
28
-**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
29
-**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
30
+
-**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
31
+
-**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
32
+
-**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
33
+
-**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
22
34
23
35
Workflows may optionally include:
24
36
@@ -30,7 +42,7 @@ Workflows may optionally include:
30
42
- Workflow files: `.github/workflows/*.md` and `.github/workflows/**/*.md`
@@ -49,30 +61,32 @@ When you interact with this agent, it will:
49
61
50
62
## Available Prompts
51
63
64
+
> **Note**: The prompt and reference files listed below are located in the [`github/gh-aw`](https://github.com/github/gh-aw) repository and are **not available locally** in this repository. Load them from their public URLs.
65
+
52
66
### Create New Workflow
53
67
**Load when**: User wants to create a new workflow from scratch, add automation, or design a workflow that doesn't exist yet
@@ -92,7 +106,7 @@ When you interact with this agent, it will:
92
106
### Create a Report-Generating Workflow
93
107
**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 +126,7 @@ When you interact with this agent, it will:
112
126
### Fix Dependabot PRs
113
127
**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,19 +136,54 @@ When you interact with this agent, it will:
122
136
### Analyze Test Coverage
123
137
**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
143
- "Analyze coverage trends over time"
130
144
- "Add a coverage gate that blocks PRs below a threshold"
131
145
146
+
### CLI Commands Reference
147
+
**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?"
153
+
- "What's the MCP equivalent of `gh aw logs`?"
154
+
- "I'm in Copilot Cloud — how do I compile a workflow?"
155
+
- "Show me all available gh aw commands"
156
+
157
+
### Token Consumption Optimization
158
+
**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?"
177
+
- "How should I structure this workflow architecture?"
178
+
- "What pattern fits slash-command triage?"
179
+
- "Should this be DispatchOps or DailyOps?"
180
+
132
181
## Instructions
133
182
134
183
When a user interacts with you:
135
184
136
185
1.**Identify the task type** from the user's request
137
-
2.**Load the appropriate prompt** from the GitHub repository URLs listed above
186
+
2.**Load the appropriate prompt** from the URLs listed above
138
187
3.**Follow the loaded prompt's instructions** exactly
139
188
4.**If uncertain**, ask clarifying questions to determine the right prompt
140
189
@@ -147,6 +196,10 @@ gh aw init
147
196
# Generate the lock file for a workflow
148
197
gh aw compile [workflow-name]
149
198
199
+
# Trigger a workflow on demand (preferred over gh workflow run)
200
+
gh aw run <workflow-name># interactive input collection
201
+
gh aw run <workflow-name> --ref main # run on a specific branch
202
+
150
203
# Debug workflow runs
151
204
gh aw logs [workflow-name]
152
205
gh aw audit <run-id>
@@ -169,10 +222,12 @@ gh aw compile --validate
169
222
170
223
## Important Notes
171
224
172
-
- Always reference the instructions file at https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/github-agentic-workflows.md for complete documentation
225
+
- Always reference the instructions file at `https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/github-agentic-workflows.md` for complete documentation
173
226
- Use the MCP tool `agentic-workflows` when running in GitHub Copilot Cloud
174
227
- Workflows must be compiled to `.lock.yml` files before running in GitHub Actions
175
228
-**Bash tools are enabled by default** - Don't restrict bash commands unnecessarily since workflows are sandboxed by the AWF
176
229
- 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.68.3/.github/aw/network.md for the full list of valid ecosystem identifiers and domain patterns.
230
+
-**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://raw.githubusercontent.com/github/gh-aw/main/.github/aw/network.md` for the full list of valid ecosystem identifiers and domain patterns.
178
231
-**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.
232
+
-**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.
233
+
-**CLI commands reference**: For a complete guide on all `gh aw` commands and their MCP tool equivalents (for restricted environments), see `https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/cli-commands.md`
0 commit comments