Skip to content

Commit 4960dd2

Browse files
authored
docs(init): sync gh-aw init prompt file and pin links to latest release (#739)
1 parent a5a5db0 commit 4960dd2

1 file changed

Lines changed: 69 additions & 11 deletions

File tree

.github/agents/agentic-workflows.agent.md

Lines changed: 69 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@ This is a **dispatcher agent** that routes your request to the appropriate speci
1919
- **Creating shared components**: Routes to `create-shared-agentic-workflow` prompt
2020
- **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
2121
- **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+
- **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
23+
- **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
24+
- **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
25+
- **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
26+
27+
> [!IMPORTANT]
28+
> For architecture/pattern-selection requests, load `https://github.com/github/gh-aw/blob/v0.74.8/.github/aw/patterns.md` first.
2229
2330
Workflows may optionally include:
2431

@@ -30,7 +37,7 @@ Workflows may optionally include:
3037
- Workflow files: `.github/workflows/*.md` and `.github/workflows/**/*.md`
3138
- Workflow lock files: `.github/workflows/*.lock.yml`
3239
- Shared components: `.github/workflows/shared/*.md`
33-
- Configuration: https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/github-agentic-workflows.md
40+
- Configuration: https://github.com/github/gh-aw/blob/v0.74.8/.github/aw/github-agentic-workflows.md
3441

3542
## Problems This Solves
3643

@@ -52,7 +59,7 @@ When you interact with this agent, it will:
5259
### Create New Workflow
5360
**Load when**: User wants to create a new workflow from scratch, add automation, or design a workflow that doesn't exist yet
5461

55-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/create-agentic-workflow.md
62+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.8/.github/aw/create-agentic-workflow.md
5663

5764
**Use cases**:
5865
- "Create a workflow that triages issues"
@@ -62,7 +69,7 @@ When you interact with this agent, it will:
6269
### Update Existing Workflow
6370
**Load when**: User wants to modify, improve, or refactor an existing workflow
6471

65-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/update-agentic-workflow.md
72+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.8/.github/aw/update-agentic-workflow.md
6673

6774
**Use cases**:
6875
- "Add web-fetch tool to the issue-classifier workflow"
@@ -72,7 +79,7 @@ When you interact with this agent, it will:
7279
### Debug Workflow
7380
**Load when**: User needs to investigate, audit, debug, or understand a workflow, troubleshoot issues, analyze logs, or fix errors
7481

75-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/debug-agentic-workflow.md
82+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.8/.github/aw/debug-agentic-workflow.md
7683

7784
**Use cases**:
7885
- "Why is this workflow failing?"
@@ -82,7 +89,7 @@ When you interact with this agent, it will:
8289
### Upgrade Agentic Workflows
8390
**Load when**: User wants to upgrade workflows to a new gh-aw version or fix deprecations
8491

85-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/upgrade-agentic-workflows.md
92+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.8/.github/aw/upgrade-agentic-workflows.md
8693

8794
**Use cases**:
8895
- "Upgrade all workflows to the latest version"
@@ -92,7 +99,7 @@ When you interact with this agent, it will:
9299
### Create a Report-Generating Workflow
93100
**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
94101

95-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/report.md
102+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.8/.github/aw/report.md
96103

97104
**Use cases**:
98105
- "Create a weekly CI health report"
@@ -102,7 +109,7 @@ When you interact with this agent, it will:
102109
### Create Shared Agentic Workflow
103110
**Load when**: User wants to create a reusable workflow component or wrap an MCP server
104111

105-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/create-shared-agentic-workflow.md
112+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.8/.github/aw/create-shared-agentic-workflow.md
106113

107114
**Use cases**:
108115
- "Create a shared component for Notion integration"
@@ -112,7 +119,7 @@ When you interact with this agent, it will:
112119
### Fix Dependabot PRs
113120
**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`)
114121

115-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/dependabot.md
122+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.8/.github/aw/dependabot.md
116123

117124
**Use cases**:
118125
- "Fix the open Dependabot PRs for npm dependencies"
@@ -122,13 +129,58 @@ When you interact with this agent, it will:
122129
### Analyze Test Coverage
123130
**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.
124131

125-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/test-coverage.md
132+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.8/.github/aw/test-coverage.md
126133

127134
**Use cases**:
128135
- "Create a workflow that comments coverage on PRs"
129136
- "Analyze coverage trends over time"
130137
- "Add a coverage gate that blocks PRs below a threshold"
131138

139+
### Render ASCII Charts in Markdown
140+
**Load when**: The workflow needs in-markdown charts (sparklines, bars, table+trend views) that must align cleanly and render reliably across GitHub surfaces, including mobile.
141+
142+
**Reference file**: https://github.com/github/gh-aw/blob/v0.74.8/.github/aw/asciicharts.md
143+
144+
**Use cases**:
145+
- "Show a compact trend chart in an issue comment"
146+
- "Render a dashboard table with sparkline trends"
147+
- "Generate aligned ASCII bars for service metrics"
148+
149+
### CLI Commands Reference
150+
**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.
151+
152+
**Reference file**: https://github.com/github/gh-aw/blob/v0.74.8/.github/aw/cli-commands.md
153+
154+
**Use cases**:
155+
- "How do I trigger workflow X on the main branch?"
156+
- "What's the MCP equivalent of `gh aw logs`?"
157+
- "I'm in Copilot Cloud — how do I compile a workflow?"
158+
- "Show me all available gh aw commands"
159+
160+
### Token Consumption Optimization
161+
**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.
162+
163+
**Reference file**: https://github.com/github/gh-aw/blob/v0.74.8/.github/aw/token-optimization.md
164+
165+
**Use cases**:
166+
- "How do I reduce the token cost of this workflow?"
167+
- "My workflow is too expensive — how do I optimize it?"
168+
- "How do I compare token usage between two runs?"
169+
- "Should I use gh-proxy or the MCP server?"
170+
- "How do I use sub-agents to reduce costs?"
171+
- "How do I measure the impact of a prompt change?"
172+
173+
### Workflow Pattern Selection
174+
**Load when**: The user asks for architecture, strategy, operating model selection, or pattern recommendations for building agentic workflows.
175+
176+
**Reference file**: https://github.com/github/gh-aw/blob/v0.74.8/.github/aw/patterns.md
177+
178+
**Use cases**:
179+
- "Which pattern should I use for multi-repo rollout?"
180+
- "How should I structure this workflow architecture?"
181+
- "What pattern fits slash-command triage?"
182+
- "Should this be DispatchOps or DailyOps?"
183+
132184
## Instructions
133185

134186
When a user interacts with you:
@@ -147,6 +199,10 @@ gh aw init
147199
# Generate the lock file for a workflow
148200
gh aw compile [workflow-name]
149201

202+
# Trigger a workflow on demand (preferred over gh workflow run)
203+
gh aw run <workflow-name> # interactive input collection
204+
gh aw run <workflow-name> --ref main # run on a specific branch
205+
150206
# Debug workflow runs
151207
gh aw logs [workflow-name]
152208
gh aw audit <run-id>
@@ -169,10 +225,12 @@ gh aw compile --validate
169225

170226
## Important Notes
171227

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
228+
- Always reference the instructions file at https://github.com/github/gh-aw/blob/v0.74.8/.github/aw/github-agentic-workflows.md for complete documentation
173229
- Use the MCP tool `agentic-workflows` when running in GitHub Copilot Cloud
174230
- Workflows must be compiled to `.lock.yml` files before running in GitHub Actions
175231
- **Bash tools are enabled by default** - Don't restrict bash commands unnecessarily since workflows are sandboxed by the AWF
176232
- 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.
233+
- **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.8/.github/aw/network.md for the full list of valid ecosystem identifiers and domain patterns.
178234
- **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.
235+
- **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.
236+
- **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.8/.github/aw/cli-commands.md

0 commit comments

Comments
 (0)