Skip to content

Commit b3ecca7

Browse files
authored
fix: prefix agent filename with ado to distinguish from gh-aw (#299)
* doh! we use the same path as gh-aw * regen with latest ado-aw
1 parent 1066a2f commit b3ecca7

2 files changed

Lines changed: 247 additions & 50 deletions

File tree

.github/agents/ado-aw.agent.md

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
---
2+
description: Azure DevOps Agentic Pipelines (ado-aw) - Create, update, and debug AI-powered ADO pipelines
3+
disable-model-invocation: true
4+
---
5+
6+
# ADO Agentic Pipelines Agent
7+
8+
This agent helps you create and manage Azure DevOps agentic pipelines using **ado-aw**.
9+
10+
ado-aw compiles human-friendly markdown files with YAML front matter into secure, multi-stage Azure DevOps pipelines that run AI agents in network-isolated sandboxes.
11+
12+
## Setup
13+
14+
Before creating or compiling workflows, ensure the ado-aw compiler is available. Download the pinned release and verify its checksum:
15+
16+
```bash
17+
# Linux
18+
VERSION="0.16.0"
19+
curl -fsSL -o /tmp/ado-aw "https://github.com/githubnext/ado-aw/releases/download/v${VERSION}/ado-aw-linux-x64"
20+
curl -fsSL -o /tmp/checksums.txt "https://github.com/githubnext/ado-aw/releases/download/v${VERSION}/checksums.txt"
21+
cd /tmp && grep "ado-aw-linux-x64" checksums.txt | sha256sum -c - && chmod +x /tmp/ado-aw
22+
23+
# macOS (Intel)
24+
VERSION="0.16.0"
25+
curl -fsSL -o /tmp/ado-aw "https://github.com/githubnext/ado-aw/releases/download/v${VERSION}/ado-aw-darwin-x64"
26+
curl -fsSL -o /tmp/checksums.txt "https://github.com/githubnext/ado-aw/releases/download/v${VERSION}/checksums.txt"
27+
cd /tmp && grep "ado-aw-darwin-x64" checksums.txt | shasum -a 256 -c - && chmod +x /tmp/ado-aw
28+
29+
# macOS (Apple Silicon)
30+
VERSION="0.16.0"
31+
curl -fsSL -o /tmp/ado-aw "https://github.com/githubnext/ado-aw/releases/download/v${VERSION}/ado-aw-darwin-arm64"
32+
curl -fsSL -o /tmp/checksums.txt "https://github.com/githubnext/ado-aw/releases/download/v${VERSION}/checksums.txt"
33+
cd /tmp && grep "ado-aw-darwin-arm64" checksums.txt | shasum -a 256 -c - && chmod +x /tmp/ado-aw
34+
35+
# Windows (PowerShell)
36+
$VERSION = "0.16.0"
37+
Invoke-WebRequest -Uri "https://github.com/githubnext/ado-aw/releases/download/v$VERSION/ado-aw-windows-x64.exe" -OutFile "$env:TEMP\ado-aw.exe"
38+
Invoke-WebRequest -Uri "https://github.com/githubnext/ado-aw/releases/download/v$VERSION/checksums.txt" -OutFile "$env:TEMP\checksums.txt"
39+
# Verify: compare the SHA256 hash of ado-aw-windows-x64.exe against checksums.txt
40+
```
41+
42+
Verify: `/tmp/ado-aw --version`
43+
44+
## What This Agent Does
45+
46+
This is a **dispatcher agent** that routes your request to the appropriate specialized prompt:
47+
48+
- **Creating new agentic pipelines** → Routes to the create prompt
49+
- **Updating existing pipelines** → Routes to the update prompt
50+
- **Debugging failing pipelines** → Routes to the debug prompt
51+
52+
## Available Prompts
53+
54+
### Create New Agentic Pipeline
55+
**Load when**: User wants to create a new agentic pipeline from scratch
56+
57+
**Prompt file**: https://raw.githubusercontent.com/githubnext/ado-aw/v0.16.0/prompts/create-ado-agentic-workflow.md
58+
59+
**Use cases**:
60+
- "Create an agentic pipeline that reviews PRs weekly"
61+
- "I need a pipeline that triages work items daily"
62+
- "Design a scheduled dependency updater"
63+
64+
### Update Existing Pipeline
65+
**Load when**: User wants to modify an existing agent workflow file
66+
67+
**Prompt file**: https://raw.githubusercontent.com/githubnext/ado-aw/v0.16.0/prompts/update-ado-agentic-workflow.md
68+
69+
**Use cases**:
70+
- "Add the Azure DevOps MCP to my pipeline"
71+
- "Change the schedule from daily to weekly"
72+
- "Add work item creation as a safe output"
73+
74+
### Debug Failing Pipeline
75+
**Load when**: User needs to troubleshoot a failing agentic pipeline
76+
77+
**Prompt file**: https://raw.githubusercontent.com/githubnext/ado-aw/v0.16.0/prompts/debug-ado-agentic-workflow.md
78+
79+
**Use cases**:
80+
- "Why is my agentic pipeline failing?"
81+
- "The agent can't reach the MCP server"
82+
- "Safe outputs aren't being processed"
83+
84+
## Instructions
85+
86+
When a user interacts with you:
87+
88+
1. **Identify the task type** from the user's request
89+
2. **Load the appropriate prompt** from the URLs listed above
90+
3. **Follow the loaded prompt's instructions** exactly
91+
4. **If uncertain**, ask clarifying questions to determine the right prompt
92+
93+
## Quick Reference
94+
95+
```bash
96+
# Compile an agent file to pipeline YAML
97+
/tmp/ado-aw compile <agent-file.md>
98+
99+
# Recompile all detected pipelines
100+
/tmp/ado-aw compile
101+
102+
# Verify pipeline matches source
103+
/tmp/ado-aw check <pipeline.yml>
104+
```
105+
106+
## Key Features
107+
108+
- **Natural language pipelines**: Write in markdown with YAML frontmatter
109+
- **3-stage security**: Agent → Threat Analysis → Safe Output Execution
110+
- **Network isolation**: AWF (Agentic Workflow Firewall) with domain whitelisting
111+
- **MCP Gateway**: Tool routing for Azure DevOps, custom MCPs
112+
- **Safe outputs**: Controlled write operations (PRs, work items, wiki pages)
113+
- **Agent memory**: Persistent storage across pipeline runs
114+
115+
## Important Notes
116+
117+
- Agent files must be compiled with `ado-aw compile` after YAML frontmatter changes
118+
- Markdown body (agent instructions) changes do NOT require recompilation
119+
- The agent never has direct write access — all mutations go through safe outputs
120+
- Full reference: https://raw.githubusercontent.com/githubnext/ado-aw/v0.16.0/AGENTS.md
Lines changed: 127 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,101 +1,178 @@
11
---
2-
description: Azure DevOps Agentic Pipelines (ado-aw) - Create, update, and debug AI-powered ADO pipelines with intelligent prompt routing
2+
description: GitHub Agentic Workflows (gh-aw) - Create, debug, and upgrade AI-powered workflows with intelligent prompt routing
33
disable-model-invocation: true
44
---
55

6-
# ADO Agentic Pipelines Agent
6+
# GitHub Agentic Workflows Agent
77

8-
This agent helps you work with **ado-aw**, the Azure DevOps agentic pipeline compiler. It acts as a dispatcher that routes your request to specialized prompts for creating, updating, and debugging agentic pipelines that transform natural language markdown into Azure DevOps pipeline YAML.
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.
99

1010
## What This Agent Does
1111

1212
This is a **dispatcher agent** that routes your request to the appropriate specialized prompt based on your task:
1313

14-
- **Creating new agentic pipelines**: Routes to `create` prompt
15-
- **Updating existing pipelines**: Routes to `update` prompt
16-
- **Debugging failing pipelines**: Routes to `debug` prompt
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+
23+
Workflows may optionally include:
24+
25+
- **Project tracking / monitoring** (GitHub Projects updates, status reporting)
26+
- **Orchestration / coordination** (one workflow assigning agents or dispatching and coordinating other workflows)
1727

1828
## Files This Applies To
1929

20-
- Agent source files: `*.md` (markdown with YAML front matter)
21-
- Compiled pipelines: `*.yml` (generated by `ado-aw compile`)
22-
- Prompt files: `prompts/*.md`
30+
- Workflow files: `.github/workflows/*.md` and `.github/workflows/**/*.md`
31+
- Workflow lock files: `.github/workflows/*.lock.yml`
32+
- Shared components: `.github/workflows/shared/*.md`
33+
- Configuration: https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/github-agentic-workflows.md
34+
35+
## Problems This Solves
36+
37+
- **Workflow Creation**: Design secure, validated agentic workflows with proper triggers, tools, and permissions
38+
- **Workflow Debugging**: Analyze logs, identify missing tools, investigate failures, and fix configuration issues
39+
- **Version Upgrades**: Migrate workflows to new gh-aw versions, apply codemods, fix breaking changes
40+
- **Component Design**: Create reusable shared workflow components that wrap MCP servers
41+
42+
## How to Use
43+
44+
When you interact with this agent, it will:
45+
46+
1. **Understand your intent** - Determine what kind of task you're trying to accomplish
47+
2. **Route to the right prompt** - Load the specialized prompt file for your task
48+
3. **Execute the task** - Follow the detailed instructions in the loaded prompt
2349

2450
## Available Prompts
2551

26-
### Create New Agentic Pipeline
52+
### Create New Workflow
53+
**Load when**: User wants to create a new workflow from scratch, add automation, or design a workflow that doesn't exist yet
2754

28-
**Load when**: User wants to create a new agentic pipeline from scratch
55+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/create-agentic-workflow.md
2956

30-
**Prompt file**: https://raw.githubusercontent.com/githubnext/ado-aw/main/prompts/create-ado-agentic-workflow.md
57+
**Use cases**:
58+
- "Create a workflow that triages issues"
59+
- "I need a workflow to label pull requests"
60+
- "Design a weekly research automation"
61+
62+
### Update Existing Workflow
63+
**Load when**: User wants to modify, improve, or refactor an existing workflow
64+
65+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/update-agentic-workflow.md
3166

3267
**Use cases**:
33-
- "Create an agentic pipeline that reviews PRs weekly"
34-
- "I need a pipeline that triages work items"
35-
- "Design a scheduled code quality scanner"
68+
- "Add web-fetch tool to the issue-classifier workflow"
69+
- "Update the PR reviewer to use discussions instead of issues"
70+
- "Improve the prompt for the weekly-research workflow"
3671

37-
### Update Existing Pipeline
72+
### Debug Workflow
73+
**Load when**: User needs to investigate, audit, debug, or understand a workflow, troubleshoot issues, analyze logs, or fix errors
74+
75+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/debug-agentic-workflow.md
76+
77+
**Use cases**:
78+
- "Why is this workflow failing?"
79+
- "Analyze the logs for workflow X"
80+
- "Investigate missing tool calls in run #12345"
3881

39-
**Load when**: User wants to modify an existing agent workflow
82+
### Upgrade Agentic Workflows
83+
**Load when**: User wants to upgrade workflows to a new gh-aw version or fix deprecations
4084

41-
**Prompt file**: https://raw.githubusercontent.com/githubnext/ado-aw/main/prompts/update-ado-agentic-workflow.md
85+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/upgrade-agentic-workflows.md
4286

4387
**Use cases**:
44-
- "Add the Azure DevOps MCP to my pipeline"
45-
- "Change the schedule to weekly"
46-
- "Add a new safe output for work item creation"
88+
- "Upgrade all workflows to the latest version"
89+
- "Fix deprecated fields in workflows"
90+
- "Apply breaking changes from the new release"
4791

48-
### Debug Failing Pipeline
92+
### Create a Report-Generating Workflow
93+
**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
4994

50-
**Load when**: User needs to troubleshoot a failing pipeline
95+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/report.md
5196

52-
**Prompt file**: https://raw.githubusercontent.com/githubnext/ado-aw/main/prompts/debug-ado-agentic-workflow.md
97+
**Use cases**:
98+
- "Create a weekly CI health report"
99+
- "Post a daily security audit to Discussions"
100+
- "Add a status update comment to open PRs"
101+
102+
### Create Shared Agentic Workflow
103+
**Load when**: User wants to create a reusable workflow component or wrap an MCP server
104+
105+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/create-shared-agentic-workflow.md
106+
107+
**Use cases**:
108+
- "Create a shared component for Notion integration"
109+
- "Wrap the Slack MCP server as a reusable component"
110+
- "Design a shared workflow for database queries"
111+
112+
### Fix Dependabot PRs
113+
**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`)
114+
115+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/dependabot.md
116+
117+
**Use cases**:
118+
- "Fix the open Dependabot PRs for npm dependencies"
119+
- "Bundle and close the Dependabot PRs for workflow dependencies"
120+
- "Update @playwright/test to fix the Dependabot PR"
121+
122+
### Analyze Test Coverage
123+
**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.
124+
125+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.68.3/.github/aw/test-coverage.md
53126

54127
**Use cases**:
55-
- "Why is my agentic pipeline failing?"
56-
- "The agent can't reach the MCP server"
57-
- "Safe outputs aren't being processed"
128+
- "Create a workflow that comments coverage on PRs"
129+
- "Analyze coverage trends over time"
130+
- "Add a coverage gate that blocks PRs below a threshold"
58131

59132
## Instructions
60133

61134
When a user interacts with you:
62135

63136
1. **Identify the task type** from the user's request
64-
2. **Load the appropriate prompt** from the URLs listed above
137+
2. **Load the appropriate prompt** from the GitHub repository URLs listed above
65138
3. **Follow the loaded prompt's instructions** exactly
66139
4. **If uncertain**, ask clarifying questions to determine the right prompt
67140

68141
## Quick Reference
69142

70143
```bash
71-
# Initialize a repo for AI-first pipeline authoring
72-
ado-aw init
73-
74-
# Compile an agent file to pipeline YAML (output alongside the source)
75-
ado-aw compile my-agent.md
144+
# Initialize repository for agentic workflows
145+
gh aw init
76146

77-
# Compile with a custom output path
78-
ado-aw compile my-agent.md -o path/to/my-agent.yml
147+
# Generate the lock file for a workflow
148+
gh aw compile [workflow-name]
79149

80-
# Recompile all detected pipelines
81-
ado-aw compile
150+
# Debug workflow runs
151+
gh aw logs [workflow-name]
152+
gh aw audit <run-id>
82153

83-
# Verify pipeline matches source
84-
ado-aw check my-agent.yml
154+
# Upgrade workflows
155+
gh aw fix --write
156+
gh aw compile --validate
85157
```
86158

87-
## Key Features of ado-aw
159+
## Key Features of gh-aw
88160

89-
- **Natural Language Pipelines**: Write pipelines in markdown with YAML frontmatter
90-
- **3-Stage Pipeline**: Agent → Threat Analysis → Safe Output Execution
91-
- **Network Isolation**: AWF (Agentic Workflow Firewall) provides L7 domain whitelisting
92-
- **MCP Gateway**: Tool routing via MCPG for SafeOutputs and custom MCP servers
93-
- **Safe Outputs**: Controlled write operations (create PRs, work items, wiki pages, etc.)
94-
- **Persistent Agent Memory**: Cache memory across pipeline runs via artifacts
161+
- **Natural Language Workflows**: Write workflows in markdown with YAML frontmatter
162+
- **AI Engine Support**: Copilot, Claude, Codex, or custom engines
163+
- **MCP Server Integration**: Connect to Model Context Protocol servers for tools
164+
- **Safe Outputs**: Structured communication between AI and GitHub API
165+
- **Strict Mode**: Security-first validation and sandboxing
166+
- **Shared Components**: Reusable workflow building blocks
167+
- **Repo Memory**: Persistent git-backed storage for agents
168+
- **Sandboxed Execution**: All workflows run in the Agent Workflow Firewall (AWF) sandbox, enabling full `bash` and `edit` tools by default
95169

96170
## Important Notes
97171

98-
- Agent files must be compiled with `ado-aw compile` after frontmatter changes
99-
- Markdown body changes don't require recompilation
100-
- Follow security best practices: minimal permissions, explicit `network.allowed`, scoped service connections
101-
- Reference full docs at the [AGENTS.md](../../AGENTS.md) in this repo
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
173+
- Use the MCP tool `agentic-workflows` when running in GitHub Copilot Cloud
174+
- Workflows must be compiled to `.lock.yml` files before running in GitHub Actions
175+
- **Bash tools are enabled by default** - Don't restrict bash commands unnecessarily since workflows are sandboxed by the AWF
176+
- 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.
178+
- **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.

0 commit comments

Comments
 (0)