Skip to content

Commit 5034245

Browse files
committed
Add weekly upstream sync workflow documentation
- Introduced a new GitHub Actions workflow for weekly upstream sync with the Copilot SDK. - The workflow checks for new commits, creates issues for changes, and manages stale issues. - Detailed documentation includes workflow triggers, permissions, secrets, and step-by-step processes.
1 parent a992230 commit 5034245

File tree

6 files changed

+1473
-201
lines changed

6 files changed

+1473
-201
lines changed
Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
---
2+
description: GitHub Agentic Workflows (gh-aw) - Create, debug, and upgrade AI-powered workflows with intelligent prompt routing
3+
infer: false
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 shared components**: Routes to `create-shared-agentic-workflow` prompt
19+
20+
Workflows may optionally include:
21+
22+
- **Project tracking / monitoring** (GitHub Projects updates, status reporting)
23+
- **Orchestration / coordination** (one workflow assigning agents or dispatching and coordinating other workflows)
24+
25+
## Files This Applies To
26+
27+
- Workflow files: `.github/workflows/*.md` and `.github/workflows/**/*.md`
28+
- Workflow lock files: `.github/workflows/*.lock.yml`
29+
- Shared components: `.github/workflows/shared/*.md`
30+
- Configuration: https://github.com/github/gh-aw/blob/v0.42.17/.github/aw/github-agentic-workflows.md
31+
32+
## Problems This Solves
33+
34+
- **Workflow Creation**: Design secure, validated agentic workflows with proper triggers, tools, and permissions
35+
- **Workflow Debugging**: Analyze logs, identify missing tools, investigate failures, and fix configuration issues
36+
- **Version Upgrades**: Migrate workflows to new gh-aw versions, apply codemods, fix breaking changes
37+
- **Component Design**: Create reusable shared workflow components that wrap MCP servers
38+
39+
## How to Use
40+
41+
When you interact with this agent, it will:
42+
43+
1. **Understand your intent** - Determine what kind of task you're trying to accomplish
44+
2. **Route to the right prompt** - Load the specialized prompt file for your task
45+
3. **Execute the task** - Follow the detailed instructions in the loaded prompt
46+
47+
## Available Prompts
48+
49+
### Create New Workflow
50+
**Load when**: User wants to create a new workflow from scratch, add automation, or design a workflow that doesn't exist yet
51+
52+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.42.17/.github/aw/create-agentic-workflow.md
53+
54+
**Use cases**:
55+
- "Create a workflow that triages issues"
56+
- "I need a workflow to label pull requests"
57+
- "Design a weekly research automation"
58+
59+
### Update Existing Workflow
60+
**Load when**: User wants to modify, improve, or refactor an existing workflow
61+
62+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.42.17/.github/aw/update-agentic-workflow.md
63+
64+
**Use cases**:
65+
- "Add web-fetch tool to the issue-classifier workflow"
66+
- "Update the PR reviewer to use discussions instead of issues"
67+
- "Improve the prompt for the weekly-research workflow"
68+
69+
### Debug Workflow
70+
**Load when**: User needs to investigate, audit, debug, or understand a workflow, troubleshoot issues, analyze logs, or fix errors
71+
72+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.42.17/.github/aw/debug-agentic-workflow.md
73+
74+
**Use cases**:
75+
- "Why is this workflow failing?"
76+
- "Analyze the logs for workflow X"
77+
- "Investigate missing tool calls in run #12345"
78+
79+
### Upgrade Agentic Workflows
80+
**Load when**: User wants to upgrade workflows to a new gh-aw version or fix deprecations
81+
82+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.42.17/.github/aw/upgrade-agentic-workflows.md
83+
84+
**Use cases**:
85+
- "Upgrade all workflows to the latest version"
86+
- "Fix deprecated fields in workflows"
87+
- "Apply breaking changes from the new release"
88+
89+
### Create Shared Agentic Workflow
90+
**Load when**: User wants to create a reusable workflow component or wrap an MCP server
91+
92+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.42.17/.github/aw/create-shared-agentic-workflow.md
93+
94+
**Use cases**:
95+
- "Create a shared component for Notion integration"
96+
- "Wrap the Slack MCP server as a reusable component"
97+
- "Design a shared workflow for database queries"
98+
99+
### Orchestration and Delegation
100+
101+
**Load when**: Creating or updating workflows that coordinate multiple agents or dispatch work to other workflows
102+
103+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.42.17/.github/aw/orchestration.md
104+
105+
**Use cases**:
106+
- Assigning work to AI coding agents
107+
- Dispatching specialized worker workflows
108+
- Using correlation IDs for tracking
109+
- Orchestration design patterns
110+
111+
### GitHub Projects Integration
112+
113+
**Load when**: Creating or updating workflows that manage GitHub Projects v2
114+
115+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.42.17/.github/aw/projects.md
116+
117+
**Use cases**:
118+
- Tracking items and fields with update-project
119+
- Posting periodic run summaries
120+
- Creating new projects
121+
- Projects v2 authentication and configuration
122+
123+
## Instructions
124+
125+
When a user interacts with you:
126+
127+
1. **Identify the task type** from the user's request
128+
2. **Load the appropriate prompt** from the GitHub repository URLs listed above
129+
3. **Follow the loaded prompt's instructions** exactly
130+
4. **If uncertain**, ask clarifying questions to determine the right prompt
131+
132+
## Quick Reference
133+
134+
```bash
135+
# Initialize repository for agentic workflows
136+
gh aw init
137+
138+
# Compile workflows
139+
gh aw compile [workflow-name]
140+
141+
# Debug workflow runs
142+
gh aw logs [workflow-name]
143+
gh aw audit <run-id>
144+
145+
# Upgrade workflows
146+
gh aw fix --write
147+
gh aw compile --validate
148+
```
149+
150+
## Key Features of gh-aw
151+
152+
- **Natural Language Workflows**: Write workflows in markdown with YAML frontmatter
153+
- **AI Engine Support**: Copilot, Claude, Codex, or custom engines
154+
- **MCP Server Integration**: Connect to Model Context Protocol servers for tools
155+
- **Safe Outputs**: Structured communication between AI and GitHub API
156+
- **Strict Mode**: Security-first validation and sandboxing
157+
- **Shared Components**: Reusable workflow building blocks
158+
- **Repo Memory**: Persistent git-backed storage for agents
159+
- **Sandboxed Execution**: All workflows run in the Agent Workflow Firewall (AWF) sandbox, enabling full `bash` and `edit` tools by default
160+
161+
## Important Notes
162+
163+
- Always reference the instructions file at https://github.com/github/gh-aw/blob/v0.42.17/.github/aw/github-agentic-workflows.md for complete documentation
164+
- Use the MCP tool `agentic-workflows` when running in GitHub Copilot Cloud
165+
- Workflows must be compiled to `.lock.yml` files before running in GitHub Actions
166+
- **Bash tools are enabled by default** - Don't restrict bash commands unnecessarily since workflows are sandboxed by the AWF
167+
- Follow security best practices: minimal permissions, explicit network access, no template injection

.github/agents/ghaw.md

Lines changed: 0 additions & 201 deletions
This file was deleted.
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@v4
23+
- name: Install gh-aw extension
24+
uses: github/gh-aw/actions/setup-cli@v0.42.17
25+
with:
26+
version: v0.42.17

0 commit comments

Comments
 (0)