mirror of
https://github.com/github/awesome-copilot.git
synced 2026-02-24 04:15:14 +00:00
Add Agentic Workflows as a new resource type
Add support for contributing Agentic Workflows — AI-powered repository automations that run coding agents in GitHub Actions, defined in markdown with natural language instructions (https://github.github.com/gh-aw). Changes: - Create workflows/ directory for community-contributed workflows - Add workflow metadata parsing (yaml-parser.mjs) - Add workflow README generation (update-readme.mjs, constants.mjs) - Add workflow data to website generation (generate-website-data.mjs) - Update README.md, CONTRIBUTING.md, and AGENTS.md with workflow docs, contributing guidelines, and code review checklists Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
35
AGENTS.md
35
AGENTS.md
@@ -9,6 +9,7 @@ The Awesome GitHub Copilot repository is a community-driven collection of custom
|
||||
- **Instructions** - Coding standards and best practices applied to specific file patterns
|
||||
- **Skills** - Self-contained folders with instructions and bundled resources for specialized tasks
|
||||
- **Hooks** - Automated workflows triggered by specific events during development
|
||||
- **Workflows** - [Agentic Workflows](https://github.github.com/gh-aw) for AI-powered repository automation in GitHub Actions
|
||||
- **Plugins** - Installable packages that group related agents, commands, and skills around specific themes
|
||||
|
||||
## Repository Structure
|
||||
@@ -20,6 +21,7 @@ The Awesome GitHub Copilot repository is a community-driven collection of custom
|
||||
├── instructions/ # Coding standards and guidelines (.instructions.md files)
|
||||
├── skills/ # Agent Skills folders (each with SKILL.md and optional bundled assets)
|
||||
├── hooks/ # Automated workflow hooks (folders with README.md + hooks.json)
|
||||
├── workflows/ # Agentic Workflows (folders with README.md + workflow .md files)
|
||||
├── plugins/ # Installable plugin packages (folders with plugin.json)
|
||||
├── docs/ # Documentation for different resource types
|
||||
├── eng/ # Build and automation scripts
|
||||
@@ -96,6 +98,17 @@ All agent files (`*.agent.md`), prompt files (`*.prompt.md`), and instruction fi
|
||||
- Follow the [GitHub Copilot hooks specification](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/coding-agent/use-hooks)
|
||||
- Optionally includes `tags` field for categorization
|
||||
|
||||
#### Workflow Folders (workflows/*/README.md)
|
||||
- Each workflow is a folder containing a `README.md` file with frontmatter and one or more `.md` workflow files
|
||||
- README.md must have `name` field (human-readable name)
|
||||
- README.md must have `description` field (wrapped in single quotes, not empty)
|
||||
- README.md should have `triggers` field (array of trigger types, e.g., `['schedule', 'issues']`)
|
||||
- Workflow `.md` files contain YAML frontmatter (`on`, `permissions`, `safe-outputs`) and natural language instructions
|
||||
- Folder names should be lower case with words separated by hyphens
|
||||
- Can include bundled assets (scripts, configuration files)
|
||||
- Optionally includes `tags` field for categorization
|
||||
- Follow the [GitHub Agentic Workflows specification](https://github.github.com/gh-aw)
|
||||
|
||||
#### Plugin Folders (plugins/*)
|
||||
- Each plugin is a folder containing a `.github/plugin/plugin.json` file with metadata
|
||||
- plugin.json must have `name` field (matching the folder name)
|
||||
@@ -107,7 +120,7 @@ All agent files (`*.agent.md`), prompt files (`*.prompt.md`), and instruction fi
|
||||
|
||||
### Adding New Resources
|
||||
|
||||
When adding a new agent, prompt, instruction, skill, hook, or plugin:
|
||||
When adding a new agent, prompt, instruction, skill, hook, workflow, or plugin:
|
||||
|
||||
**For Agents, Prompts, and Instructions:**
|
||||
1. Create the file with proper front matter
|
||||
@@ -125,6 +138,15 @@ When adding a new agent, prompt, instruction, skill, hook, or plugin:
|
||||
7. Verify the hook appears in the generated README
|
||||
|
||||
|
||||
**For Workflows:**
|
||||
1. Create a new folder in `workflows/` with a descriptive name
|
||||
2. Create `README.md` with proper frontmatter (name, description, triggers, tags)
|
||||
3. Add one or more `.md` workflow files with `on`, `permissions`, and `safe-outputs` frontmatter
|
||||
4. Add any bundled scripts or assets to the folder
|
||||
5. Update the README.md by running: `npm run build`
|
||||
6. Verify the workflow appears in the generated README
|
||||
|
||||
|
||||
**For Skills:**
|
||||
1. Run `npm run skill:create` to scaffold a new skill folder
|
||||
2. Edit the generated SKILL.md file with your instructions
|
||||
@@ -241,6 +263,17 @@ For hook folders (hooks/*/):
|
||||
- [ ] Follows [GitHub Copilot hooks specification](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/coding-agent/use-hooks)
|
||||
- [ ] Optionally includes `tags` array field for categorization
|
||||
|
||||
For workflow folders (workflows/*/):
|
||||
- [ ] Folder contains a README.md file with markdown front matter
|
||||
- [ ] Has `name` field with human-readable name
|
||||
- [ ] Has non-empty `description` field wrapped in single quotes
|
||||
- [ ] Has `triggers` array field listing workflow trigger types
|
||||
- [ ] Folder name is lower case with hyphens
|
||||
- [ ] Contains at least one `.md` workflow file with `on` and `permissions` in frontmatter
|
||||
- [ ] Workflow uses least-privilege permissions and safe outputs
|
||||
- [ ] Follows [GitHub Agentic Workflows specification](https://github.github.com/gh-aw)
|
||||
- [ ] Optionally includes `tags` array field for categorization
|
||||
|
||||
For plugins (plugins/*/):
|
||||
- [ ] Directory contains a `.github/plugin/plugin.json` file
|
||||
- [ ] Directory contains a `README.md` file
|
||||
|
||||
Reference in New Issue
Block a user