Skip to content

Commit 569cc6b

Browse files
Merge branch 'staged' into dev/davidraygoza/CppLSToolsInstructions
2 parents e864b42 + b35e636 commit 569cc6b

1,645 files changed

Lines changed: 282668 additions & 59858 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.all-contributorsrc

Lines changed: 1751 additions & 12 deletions
Large diffs are not rendered by default.

.codespellrc

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,28 @@
3434

3535
# FillIn - pdftk-server skill reference file available permission
3636

37-
ignore-words-list = numer,wit,aks,edn,ser,ois,gir,rouge,categor,aline,ative,afterall,deques,dateA,dateB,TE,FillIn,alle,vai
37+
# LOD - Level of Detail
38+
39+
# InOut - template property in skills/game-engine/assets/2d-platform-game.md
40+
41+
# pixelX - template variable in skill/game-engine/assets/simple-2d-engine.md
42+
43+
# aNULL - HTTPS configuration cipher string
44+
45+
# Wee, Sherif - proper name (Wee, Sherif, contributor names should not be flagged as typos)
46+
47+
# queston - intentional misspelling example in skills/arize-dataset/SKILL.md demonstrating typo detection in field names
48+
49+
# nin - MongoDB $nin operator in security instructions NoSQL injection detection regex
50+
51+
# Vertexes - FreeCAD shape sub-elements used as property of obj.Shape
52+
53+
# FO - tasklist option /FO to format running task output
54+
55+
# CAF - Microsoft Cloud Adoption Framework acronym
56+
57+
ignore-words-list = numer,wit,aks,edn,ser,ois,gir,rouge,categor,aline,ative,afterall,deques,dateA,dateB,TE,FillIn,alle,vai,LOD,InOut,pixelX,aNULL,Wee,Sherif,queston,Vertexes,nin,FO,CAF,Parth
3858

3959
# Skip certain files and directories
4060

41-
skip = .git,node_modules,package-lock.json,*.lock,website/build,website/.docusaurus
61+
skip = .git,node_modules,package-lock.json,*.lock,website/build,website/.docusaurus,.all-contributorrc,./skills/geofeed-tuner/assets/*.json,./skills/geofeed-tuner/references/*.txt,./plugins/fastah-ip-geo-tools/skills/geofeed-tuner/assets/*.json,./plugins/fastah-ip-geo-tools/skills/geofeed-tuner/references/*.txt
Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
name: External plugin submission
2+
description: Submit a public GitHub-hosted external plugin for marketplace review.
3+
title: "[External Plugin]: "
4+
labels:
5+
- external-plugin
6+
- awaiting-review
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
<!-- external-plugin-submission -->
12+
Thanks for submitting a public external plugin.
13+
14+
Before you continue:
15+
- Public submissions are **GitHub-only** in v1.
16+
- The plugin must live in a **public GitHub repository**.
17+
- Provide an immutable **ref**, **sha**, or both for review.
18+
- Do **not** open a PR that edits `plugins/external.json` directly.
19+
- type: input
20+
id: plugin-name
21+
attributes:
22+
label: Plugin name
23+
description: Lowercase letters, numbers, and hyphens only.
24+
placeholder: my-plugin
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: short-description
29+
attributes:
30+
label: Short description
31+
description: One or two sentences describing the plugin.
32+
placeholder: Helps developers...
33+
validations:
34+
required: true
35+
- type: input
36+
id: github-repository
37+
attributes:
38+
label: GitHub repository
39+
description: Public GitHub repository in owner/repo format.
40+
placeholder: owner/repo
41+
validations:
42+
required: true
43+
- type: input
44+
id: plugin-path
45+
attributes:
46+
label: Plugin path inside the repository
47+
description: Optional if the plugin lives at the repository root. Otherwise, enter the folder where the plugin structure starts, not the plugin.json file.
48+
placeholder: plugins/my-plugin
49+
validations:
50+
required: false
51+
- type: input
52+
id: immutable-ref
53+
attributes:
54+
label: Ref to review
55+
description: Optional release tag or tag ref. Submit this, a commit SHA, or both.
56+
placeholder: v1.2.3
57+
validations:
58+
required: false
59+
- type: input
60+
id: immutable-sha
61+
attributes:
62+
label: Commit SHA to review
63+
description: Optional full 40-character commit SHA. Submit this, a ref, or both.
64+
placeholder: 0123456789abcdef0123456789abcdef01234567
65+
validations:
66+
required: false
67+
- type: input
68+
id: version
69+
attributes:
70+
label: Version
71+
placeholder: 1.0.0
72+
validations:
73+
required: true
74+
- type: input
75+
id: license
76+
attributes:
77+
label: License identifier
78+
description: SPDX identifier or other license string.
79+
placeholder: MIT
80+
validations:
81+
required: true
82+
- type: input
83+
id: author-name
84+
attributes:
85+
label: Author name
86+
placeholder: Example Maintainers
87+
validations:
88+
required: true
89+
- type: input
90+
id: author-url
91+
attributes:
92+
label: Author URL
93+
description: Optional HTTPS URL.
94+
placeholder: https://example.com
95+
validations:
96+
required: false
97+
- type: input
98+
id: homepage-url
99+
attributes:
100+
label: Homepage URL
101+
description: Optional HTTPS URL if different from the repository URL.
102+
placeholder: https://example.com/plugin
103+
validations:
104+
required: false
105+
- type: textarea
106+
id: keywords
107+
attributes:
108+
label: Keywords
109+
description: Comma-separated or newline-separated lowercase tags.
110+
placeholder: |
111+
automation
112+
github
113+
copilot
114+
validations:
115+
required: true
116+
- type: textarea
117+
id: additional-notes
118+
attributes:
119+
label: Additional notes for reviewers
120+
description: Optional context that helps maintainers review the plugin.
121+
validations:
122+
required: false
123+
- type: checkboxes
124+
id: submission-checklist
125+
attributes:
126+
label: Submission checklist
127+
options:
128+
- label: The plugin lives in a public GitHub repository.
129+
required: true
130+
- label: The ref and/or sha I provided is immutable (release tag and/or full 40-character commit SHA), not a branch.
131+
required: true
132+
- label: This submission follows this repository's contribution, security, and responsible AI policies.
133+
required: true
134+
- label: This plugin is not already listed in the Awesome Copilot marketplace.
135+
required: true
Lines changed: 196 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,196 @@
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+
- **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
23+
24+
Workflows may optionally include:
25+
26+
- **Project tracking / monitoring** (GitHub Projects updates, status reporting)
27+
- **Orchestration / coordination** (one workflow assigning agents or dispatching and coordinating other workflows)
28+
29+
## Files This Applies To
30+
31+
- Workflow files: `.github/workflows/*.md` and `.github/workflows/**/*.md`
32+
- Workflow lock files: `.github/workflows/*.lock.yml`
33+
- Shared components: `.github/workflows/shared/*.md`
34+
- Configuration: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/github-agentic-workflows.md
35+
36+
## Problems This Solves
37+
38+
- **Workflow Creation**: Design secure, validated agentic workflows with proper triggers, tools, and permissions
39+
- **Workflow Debugging**: Analyze logs, identify missing tools, investigate failures, and fix configuration issues
40+
- **Version Upgrades**: Migrate workflows to new gh-aw versions, apply codemods, fix breaking changes
41+
- **Component Design**: Create reusable shared workflow components that wrap MCP servers
42+
43+
## How to Use
44+
45+
When you interact with this agent, it will:
46+
47+
1. **Understand your intent** - Determine what kind of task you're trying to accomplish
48+
2. **Route to the right prompt** - Load the specialized prompt file for your task
49+
3. **Execute the task** - Follow the detailed instructions in the loaded prompt
50+
51+
## Available Prompts
52+
53+
### Create New Workflow
54+
**Load when**: User wants to create a new workflow from scratch, add automation, or design a workflow that doesn't exist yet
55+
56+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/create-agentic-workflow.md
57+
58+
**Use cases**:
59+
- "Create a workflow that triages issues"
60+
- "I need a workflow to label pull requests"
61+
- "Design a weekly research automation"
62+
63+
### Update Existing Workflow
64+
**Load when**: User wants to modify, improve, or refactor an existing workflow
65+
66+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/update-agentic-workflow.md
67+
68+
**Use cases**:
69+
- "Add web-fetch tool to the issue-classifier workflow"
70+
- "Update the PR reviewer to use discussions instead of issues"
71+
- "Improve the prompt for the weekly-research workflow"
72+
73+
### Debug Workflow
74+
**Load when**: User needs to investigate, audit, debug, or understand a workflow, troubleshoot issues, analyze logs, or fix errors
75+
76+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/debug-agentic-workflow.md
77+
78+
**Use cases**:
79+
- "Why is this workflow failing?"
80+
- "Analyze the logs for workflow X"
81+
- "Investigate missing tool calls in run #12345"
82+
83+
### Upgrade Agentic Workflows
84+
**Load when**: User wants to upgrade workflows to a new gh-aw version or fix deprecations
85+
86+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/upgrade-agentic-workflows.md
87+
88+
**Use cases**:
89+
- "Upgrade all workflows to the latest version"
90+
- "Fix deprecated fields in workflows"
91+
- "Apply breaking changes from the new release"
92+
93+
### Create a Report-Generating Workflow
94+
**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
95+
96+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/report.md
97+
98+
**Use cases**:
99+
- "Create a weekly CI health report"
100+
- "Post a daily security audit to Discussions"
101+
- "Add a status update comment to open PRs"
102+
103+
### Create Shared Agentic Workflow
104+
**Load when**: User wants to create a reusable workflow component or wrap an MCP server
105+
106+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/create-shared-agentic-workflow.md
107+
108+
**Use cases**:
109+
- "Create a shared component for Notion integration"
110+
- "Wrap the Slack MCP server as a reusable component"
111+
- "Design a shared workflow for database queries"
112+
113+
### Fix Dependabot PRs
114+
**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`)
115+
116+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/dependabot.md
117+
118+
**Use cases**:
119+
- "Fix the open Dependabot PRs for npm dependencies"
120+
- "Bundle and close the Dependabot PRs for workflow dependencies"
121+
- "Update @playwright/test to fix the Dependabot PR"
122+
123+
### Analyze Test Coverage
124+
**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.
125+
126+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.71.5/.github/aw/test-coverage.md
127+
128+
**Use cases**:
129+
- "Create a workflow that comments coverage on PRs"
130+
- "Analyze coverage trends over time"
131+
- "Add a coverage gate that blocks PRs below a threshold"
132+
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+
144+
## Instructions
145+
146+
When a user interacts with you:
147+
148+
1. **Identify the task type** from the user's request
149+
2. **Load the appropriate prompt** from the GitHub repository URLs listed above
150+
3. **Follow the loaded prompt's instructions** exactly
151+
4. **If uncertain**, ask clarifying questions to determine the right prompt
152+
153+
## Quick Reference
154+
155+
```bash
156+
# Initialize repository for agentic workflows
157+
gh aw init
158+
159+
# Generate the lock file for a workflow
160+
gh aw compile [workflow-name]
161+
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+
166+
# Debug workflow runs
167+
gh aw logs [workflow-name]
168+
gh aw audit <run-id>
169+
170+
# Upgrade workflows
171+
gh aw fix --write
172+
gh aw compile --validate
173+
```
174+
175+
## Key Features of gh-aw
176+
177+
- **Natural Language Workflows**: Write workflows in markdown with YAML frontmatter
178+
- **AI Engine Support**: Copilot, Claude, Codex, or custom engines
179+
- **MCP Server Integration**: Connect to Model Context Protocol servers for tools
180+
- **Safe Outputs**: Structured communication between AI and GitHub API
181+
- **Strict Mode**: Security-first validation and sandboxing
182+
- **Shared Components**: Reusable workflow building blocks
183+
- **Repo Memory**: Persistent git-backed storage for agents
184+
- **Sandboxed Execution**: All workflows run in the Agent Workflow Firewall (AWF) sandbox, enabling full `bash` and `edit` tools by default
185+
186+
## Important Notes
187+
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
189+
- Use the MCP tool `agentic-workflows` when running in GitHub Copilot Cloud
190+
- Workflows must be compiled to `.lock.yml` files before running in GitHub Actions
191+
- **Bash tools are enabled by default** - Don't restrict bash commands unnecessarily since workflows are sandboxed by the AWF
192+
- 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.
194+
- **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

0 commit comments

Comments
 (0)