Skip to content

Commit 0d9792b

Browse files
authored
updating agentic workflows (#1666)
1 parent e67c66c commit 0d9792b

10 files changed

Lines changed: 1315 additions & 526 deletions

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

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ 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+
- **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
2223

2324
Workflows may optionally include:
2425

@@ -30,7 +31,7 @@ Workflows may optionally include:
3031
- Workflow files: `.github/workflows/*.md` and `.github/workflows/**/*.md`
3132
- Workflow lock files: `.github/workflows/*.lock.yml`
3233
- Shared components: `.github/workflows/shared/*.md`
33-
- Configuration: https://github.com/github/gh-aw/blob/v0.57.2/.github/aw/github-agentic-workflows.md
34+
- Configuration: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/github-agentic-workflows.md
3435

3536
## Problems This Solves
3637

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

55-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.57.2/.github/aw/create-agentic-workflow.md
56+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/create-agentic-workflow.md
5657

5758
**Use cases**:
5859
- "Create a workflow that triages issues"
@@ -62,7 +63,7 @@ When you interact with this agent, it will:
6263
### Update Existing Workflow
6364
**Load when**: User wants to modify, improve, or refactor an existing workflow
6465

65-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.57.2/.github/aw/update-agentic-workflow.md
66+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/update-agentic-workflow.md
6667

6768
**Use cases**:
6869
- "Add web-fetch tool to the issue-classifier workflow"
@@ -72,7 +73,7 @@ When you interact with this agent, it will:
7273
### Debug Workflow
7374
**Load when**: User needs to investigate, audit, debug, or understand a workflow, troubleshoot issues, analyze logs, or fix errors
7475

75-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.57.2/.github/aw/debug-agentic-workflow.md
76+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/debug-agentic-workflow.md
7677

7778
**Use cases**:
7879
- "Why is this workflow failing?"
@@ -82,7 +83,7 @@ When you interact with this agent, it will:
8283
### Upgrade Agentic Workflows
8384
**Load when**: User wants to upgrade workflows to a new gh-aw version or fix deprecations
8485

85-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.57.2/.github/aw/upgrade-agentic-workflows.md
86+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/upgrade-agentic-workflows.md
8687

8788
**Use cases**:
8889
- "Upgrade all workflows to the latest version"
@@ -92,7 +93,7 @@ When you interact with this agent, it will:
9293
### Create a Report-Generating Workflow
9394
**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
9495

95-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.57.2/.github/aw/report.md
96+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/report.md
9697

9798
**Use cases**:
9899
- "Create a weekly CI health report"
@@ -102,7 +103,7 @@ When you interact with this agent, it will:
102103
### Create Shared Agentic Workflow
103104
**Load when**: User wants to create a reusable workflow component or wrap an MCP server
104105

105-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.57.2/.github/aw/create-shared-agentic-workflow.md
106+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/create-shared-agentic-workflow.md
106107

107108
**Use cases**:
108109
- "Create a shared component for Notion integration"
@@ -112,7 +113,7 @@ When you interact with this agent, it will:
112113
### Fix Dependabot PRs
113114
**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`)
114115

115-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.57.2/.github/aw/dependabot.md
116+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/dependabot.md
116117

117118
**Use cases**:
118119
- "Fix the open Dependabot PRs for npm dependencies"
@@ -122,13 +123,24 @@ When you interact with this agent, it will:
122123
### Analyze Test Coverage
123124
**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.
124125

125-
**Prompt file**: https://github.com/github/gh-aw/blob/v0.57.2/.github/aw/test-coverage.md
126+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/test-coverage.md
126127

127128
**Use cases**:
128129
- "Create a workflow that comments coverage on PRs"
129130
- "Analyze coverage trends over time"
130131
- "Add a coverage gate that blocks PRs below a threshold"
131132

133+
### CLI Commands Reference
134+
**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.
135+
136+
**Reference file**: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/cli-commands.md
137+
138+
**Use cases**:
139+
- "How do I trigger workflow X on the main branch?"
140+
- "What's the MCP equivalent of `gh aw logs`?"
141+
- "I'm in Copilot Cloud — how do I compile a workflow?"
142+
- "Show me all available gh aw commands"
143+
132144
## Instructions
133145

134146
When a user interacts with you:
@@ -147,6 +159,10 @@ gh aw init
147159
# Generate the lock file for a workflow
148160
gh aw compile [workflow-name]
149161

162+
# Trigger a workflow on demand (preferred over gh workflow run)
163+
gh aw run <workflow-name> # interactive input collection
164+
gh aw run <workflow-name> --ref main # run on a specific branch
165+
150166
# Debug workflow runs
151167
gh aw logs [workflow-name]
152168
gh aw audit <run-id>
@@ -169,9 +185,12 @@ gh aw compile --validate
169185

170186
## Important Notes
171187

172-
- Always reference the instructions file at https://github.com/github/gh-aw/blob/v0.57.2/.github/aw/github-agentic-workflows.md for complete documentation
188+
- Always reference the instructions file at https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/github-agentic-workflows.md for complete documentation
173189
- Use the MCP tool `agentic-workflows` when running in GitHub Copilot Cloud
174190
- Workflows must be compiled to `.lock.yml` files before running in GitHub Actions
175191
- **Bash tools are enabled by default** - Don't restrict bash commands unnecessarily since workflows are sandboxed by the AWF
176192
- Follow security best practices: minimal permissions, explicit network access, no template injection
193+
- **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.71.5/.github/aw/network.md for the full list of valid ecosystem identifiers and domain patterns.
177194
- **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.
195+
- **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.
196+
- **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.71.5/.github/aw/cli-commands.md

.github/aw/actions-lock.json

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,30 +10,25 @@
1010
"version": "v8.0.1",
1111
"sha": "3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c"
1212
},
13-
"actions/github-script@v8": {
13+
"actions/github-script@v9.0.0": {
1414
"repo": "actions/github-script",
15-
"version": "v8",
16-
"sha": "ed597411d8f924073f98dfc5c65a23a2325f34cd"
15+
"version": "v9.0.0",
16+
"sha": "3a2844b7e9c422d3c10d287c895573f7108da1b3"
1717
},
18-
"actions/github-script@v9": {
19-
"repo": "actions/github-script",
20-
"version": "v9",
21-
"sha": "373c709c69115d41ff229c7e5df9f8788daa9553"
22-
},
23-
"actions/upload-artifact@v7.0.0": {
18+
"actions/upload-artifact@v7.0.1": {
2419
"repo": "actions/upload-artifact",
25-
"version": "v7.0.0",
26-
"sha": "bbbca2ddaa5d8feaa63e36b76fdaad77386f024f"
20+
"version": "v7.0.1",
21+
"sha": "043fb46d1a93c77aae656e7c1c64a875d1fc6a0a"
2722
},
28-
"github/gh-aw-actions/setup@v0.68.3": {
23+
"github/gh-aw-actions/setup@v0.71.5": {
2924
"repo": "github/gh-aw-actions/setup",
30-
"version": "v0.68.3",
31-
"sha": "ba90f2186d7ad780ec640f364005fa24e797b360"
25+
"version": "v0.71.5",
26+
"sha": "b8068426813005612b960b5ab0b8bd2c27142323"
3227
},
33-
"github/gh-aw/actions/setup@v0.64.2": {
28+
"github/gh-aw/actions/setup@v0.71.5": {
3429
"repo": "github/gh-aw/actions/setup",
35-
"version": "v0.64.2",
36-
"sha": "72346ee09bdaa904d167f1be907e590fd9128fa3"
30+
"version": "v0.71.5",
31+
"sha": "19ac811a4a85389c33b15128e1d7b7d4507f814a"
3732
}
3833
}
3934
}

0 commit comments

Comments
 (0)