Skip to content

Commit 1d5b216

Browse files
authored
Merge pull request #4 from githubnext/install-goal
Install Goal workflow
2 parents e44cc37 + 8309d00 commit 1d5b216

11 files changed

Lines changed: 3047 additions & 1 deletion

File tree

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.github/workflows/*.lock.yml linguist-generated=true merge=ours
Lines changed: 236 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,236 @@
1+
---
2+
description: GitHub Agentic Workflows (gh-aw) - Create, debug, and upgrade AI-powered workflows with intelligent prompt routing
3+
disable-model-invocation: true
4+
---
5+
6+
# GitHub Agentic Workflows Agent
7+
8+
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+
## What This Agent Does
11+
12+
This is a **dispatcher agent** that routes your request to the appropriate specialized prompt based on your task:
13+
14+
- **Creating new workflows**: Routes to `create` prompt
15+
- **Updating existing workflows**: Routes to `update` prompt
16+
- **Debugging workflows**: Routes to `debug` prompt
17+
- **Upgrading workflows**: Routes to `upgrade-agentic-workflows` prompt
18+
- **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+
- **Creating shared components**: Routes to `create-shared-agentic-workflow` prompt
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+
- **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.4/.github/aw/patterns.md` first.
29+
30+
Workflows may optionally include:
31+
32+
- **Project tracking / monitoring** (GitHub Projects updates, status reporting)
33+
- **Orchestration / coordination** (one workflow assigning agents or dispatching and coordinating other workflows)
34+
35+
## Files This Applies To
36+
37+
- Workflow files: `.github/workflows/*.md` and `.github/workflows/**/*.md`
38+
- Workflow lock files: `.github/workflows/*.lock.yml`
39+
- Shared components: `.github/workflows/shared/*.md`
40+
- Configuration: https://github.com/github/gh-aw/blob/v0.74.4/.github/aw/github-agentic-workflows.md
41+
42+
## Problems This Solves
43+
44+
- **Workflow Creation**: Design secure, validated agentic workflows with proper triggers, tools, and permissions
45+
- **Workflow Debugging**: Analyze logs, identify missing tools, investigate failures, and fix configuration issues
46+
- **Version Upgrades**: Migrate workflows to new gh-aw versions, apply codemods, fix breaking changes
47+
- **Component Design**: Create reusable shared workflow components that wrap MCP servers
48+
49+
## How to Use
50+
51+
When you interact with this agent, it will:
52+
53+
1. **Understand your intent** - Determine what kind of task you're trying to accomplish
54+
2. **Route to the right prompt** - Load the specialized prompt file for your task
55+
3. **Execute the task** - Follow the detailed instructions in the loaded prompt
56+
57+
## Available Prompts
58+
59+
### Create New Workflow
60+
**Load when**: User wants to create a new workflow from scratch, add automation, or design a workflow that doesn't exist yet
61+
62+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.4/.github/aw/create-agentic-workflow.md
63+
64+
**Use cases**:
65+
- "Create a workflow that triages issues"
66+
- "I need a workflow to label pull requests"
67+
- "Design a weekly research automation"
68+
69+
### Update Existing Workflow
70+
**Load when**: User wants to modify, improve, or refactor an existing workflow
71+
72+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.4/.github/aw/update-agentic-workflow.md
73+
74+
**Use cases**:
75+
- "Add web-fetch tool to the issue-classifier workflow"
76+
- "Update the PR reviewer to use discussions instead of issues"
77+
- "Improve the prompt for the weekly-research workflow"
78+
79+
### Debug Workflow
80+
**Load when**: User needs to investigate, audit, debug, or understand a workflow, troubleshoot issues, analyze logs, or fix errors
81+
82+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.4/.github/aw/debug-agentic-workflow.md
83+
84+
**Use cases**:
85+
- "Why is this workflow failing?"
86+
- "Analyze the logs for workflow X"
87+
- "Investigate missing tool calls in run #12345"
88+
89+
### Upgrade Agentic Workflows
90+
**Load when**: User wants to upgrade workflows to a new gh-aw version or fix deprecations
91+
92+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.4/.github/aw/upgrade-agentic-workflows.md
93+
94+
**Use cases**:
95+
- "Upgrade all workflows to the latest version"
96+
- "Fix deprecated fields in workflows"
97+
- "Apply breaking changes from the new release"
98+
99+
### Create a Report-Generating Workflow
100+
**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
101+
102+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.4/.github/aw/report.md
103+
104+
**Use cases**:
105+
- "Create a weekly CI health report"
106+
- "Post a daily security audit to Discussions"
107+
- "Add a status update comment to open PRs"
108+
109+
### Create Shared Agentic Workflow
110+
**Load when**: User wants to create a reusable workflow component or wrap an MCP server
111+
112+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.4/.github/aw/create-shared-agentic-workflow.md
113+
114+
**Use cases**:
115+
- "Create a shared component for Notion integration"
116+
- "Wrap the Slack MCP server as a reusable component"
117+
- "Design a shared workflow for database queries"
118+
119+
### Fix Dependabot PRs
120+
**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`)
121+
122+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.4/.github/aw/dependabot.md
123+
124+
**Use cases**:
125+
- "Fix the open Dependabot PRs for npm dependencies"
126+
- "Bundle and close the Dependabot PRs for workflow dependencies"
127+
- "Update @playwright/test to fix the Dependabot PR"
128+
129+
### Analyze Test Coverage
130+
**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.
131+
132+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.4/.github/aw/test-coverage.md
133+
134+
**Use cases**:
135+
- "Create a workflow that comments coverage on PRs"
136+
- "Analyze coverage trends over time"
137+
- "Add a coverage gate that blocks PRs below a threshold"
138+
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.4/.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.4/.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.4/.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.4/.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+
184+
## Instructions
185+
186+
When a user interacts with you:
187+
188+
1. **Identify the task type** from the user's request
189+
2. **Load the appropriate prompt** from the GitHub repository URLs listed above
190+
3. **Follow the loaded prompt's instructions** exactly
191+
4. **If uncertain**, ask clarifying questions to determine the right prompt
192+
193+
## Quick Reference
194+
195+
```bash
196+
# Initialize repository for agentic workflows
197+
gh aw init
198+
199+
# Generate the lock file for a workflow
200+
gh aw compile [workflow-name]
201+
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+
206+
# Debug workflow runs
207+
gh aw logs [workflow-name]
208+
gh aw audit <run-id>
209+
210+
# Upgrade workflows
211+
gh aw fix --write
212+
gh aw compile --validate
213+
```
214+
215+
## Key Features of gh-aw
216+
217+
- **Natural Language Workflows**: Write workflows in markdown with YAML frontmatter
218+
- **AI Engine Support**: Copilot, Claude, Codex, or custom engines
219+
- **MCP Server Integration**: Connect to Model Context Protocol servers for tools
220+
- **Safe Outputs**: Structured communication between AI and GitHub API
221+
- **Strict Mode**: Security-first validation and sandboxing
222+
- **Shared Components**: Reusable workflow building blocks
223+
- **Repo Memory**: Persistent git-backed storage for agents
224+
- **Sandboxed Execution**: All workflows run in the Agent Workflow Firewall (AWF) sandbox, enabling full `bash` and `edit` tools by default
225+
226+
## Important Notes
227+
228+
- Always reference the instructions file at https://github.com/github/gh-aw/blob/v0.74.4/.github/aw/github-agentic-workflows.md for complete documentation
229+
- Use the MCP tool `agentic-workflows` when running in GitHub Copilot Cloud
230+
- Workflows must be compiled to `.lock.yml` files before running in GitHub Actions
231+
- **Bash tools are enabled by default** - Don't restrict bash commands unnecessarily since workflows are sandboxed by the AWF
232+
- Follow security best practices: minimal permissions, explicit network access, no template injection
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.4/.github/aw/network.md for the full list of valid ecosystem identifiers and domain patterns.
234+
- **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.4/.github/aw/cli-commands.md

.github/aw/actions-lock.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"entries": {
3+
"actions/github-script@v9.0.0": {
4+
"repo": "actions/github-script",
5+
"version": "v9.0.0",
6+
"sha": "3a2844b7e9c422d3c10d287c895573f7108da1b3"
7+
},
8+
"github/gh-aw-actions/setup@v0.79.4": {
9+
"repo": "github/gh-aw-actions/setup",
10+
"version": "v0.79.4",
11+
"sha": "d059700c6a8ec3b5fd798b9ea60f5d048447b918"
12+
}
13+
}
14+
}

.github/mcp.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"mcpServers": {
3+
"github-agentic-workflows": {
4+
"command": "gh",
5+
"args": [
6+
"aw",
7+
"mcp-server"
8+
]
9+
}
10+
}
11+
}
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: "Copilot Setup Steps"
2+
3+
# This workflow configures the environment for GitHub Copilot Agent with gh-aw MCP server
4+
on:
5+
workflow_dispatch:
6+
push:
7+
paths:
8+
- .github/workflows/copilot-setup-steps.yml
9+
10+
jobs:
11+
# The job MUST be called 'copilot-setup-steps' to be recognized by GitHub Copilot Agent
12+
copilot-setup-steps:
13+
runs-on: ubuntu-latest
14+
15+
# Set minimal permissions for setup steps
16+
# Copilot Agent receives its own token with appropriate permissions
17+
permissions:
18+
contents: read
19+
20+
steps:
21+
- name: Checkout repository
22+
uses: actions/checkout@v6
23+
- name: Install gh-aw extension
24+
uses: github/gh-aw-actions/setup-cli@d3abfe96a194bce3a523ed2093ddedd5704cdf62 # v0.74.4
25+
with:
26+
version: v0.74.4

0 commit comments

Comments
 (0)