Awesome/awesome-copilot
1
0
Fork 0
mirror of https://github.com/github/awesome-copilot.git synced 2026-02-24 12:25:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add Agentic Workflows as a new resource type

Browse Source 
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:
Bruno Borges
2026-02-20 15:28:28 -08:00
parent 7bebd4a385
commit 997d6302bd
9 changed files with 402 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
CONTRIBUTING.md
View File

@@ -161,11 +161,75 @@ plugins/my-plugin-id/
- **Clear purpose**: The plugin should solve a specific problem or workflow
- **Validate before submitting**: Run `npm run plugin:validate` to ensure your plugin is valid
### Adding Agentic Workflows
[Agentic Workflows](https://github.github.com/gh-aw) are AI-powered repository automations that run coding agents in GitHub Actions. Defined in markdown with natural language instructions, they enable scheduled and event-triggered automation with built-in guardrails.
1. **Create a new workflow folder**: Add a new folder in the `workflows/` directory with a descriptive name (e.g., `daily-issues-report`)
2. **Create a `README.md`**: Add a `README.md` with frontmatter containing `name`, `description`, `triggers`, and optionally `tags`
3. **Add workflow files**: Include one or more `.md` workflow files with YAML frontmatter (`on`, `permissions`, `safe-outputs`) and natural language instructions
4. **Add optional assets**: Include any helper scripts or configuration files referenced by the workflow
5. **Update the README**: Run `npm run build` to update the generated README tables
#### Workflow folder structure
```
workflows/daily-issues-report/
├── README.md # Workflow documentation with frontmatter
└── daily-issues-report.md # Agentic workflow file
```
#### README.md frontmatter example
```markdown
---
name: 'Daily Issues Report'
description: 'Generates a daily summary of open issues and recent activity as a GitHub issue'
triggers: ['schedule']
tags: ['reporting', 'issues', 'automation']
---
```
#### Workflow file example
```markdown
---
on:
schedule: daily on weekdays
permissions:
contents: read
issues: read
safe-outputs:
create-issue:
title-prefix: "[daily-report] "
labels: [report]
---
## Daily Issues Report
Create a daily summary of open issues for the team.
## What to Include
- New issues opened in the last 24 hours
- Issues closed or resolved
- Stale issues that need attention
```
#### Workflow Guidelines
- **Security first**: Use least-privilege permissions and safe outputs instead of direct write access
- **Clear instructions**: Write clear natural language instructions in the workflow body
- **Descriptive names**: Use lowercase folder names with hyphens
- **Test locally**: Use `gh aw run` to test workflows before contributing
- **Documentation**: Include a thorough README explaining what the workflow does and how to use it
- Learn more at the [Agentic Workflows documentation](https://github.github.com/gh-aw)
## Submitting Your Contribution
1. **Fork this repository**
2. **Create a new branch** for your contribution
3. **Add your instruction, prompt file, chatmode, or plugin** following the guidelines above
3. **Add your instruction, prompt file, chatmode, workflow, or plugin** following the guidelines above
4. **Run the update script**: `npm start` to update the README with your new file (make sure you run `npm install` first if you haven't already)
- A GitHub Actions workflow will verify that this step was performed correctly
- If the README.md would be modified by running the script, the PR check will fail with a comment showing the required changes
@@ -234,6 +298,7 @@ We welcome many kinds of contributions, including the custom categories below:
| **Prompts** | Reusable or one-off prompts for GitHub Copilot | ⌨️ |
| **Agents** | Defined GitHub Copilot roles or personalities | 🎭 |
| **Skills** | Specialized knowledge of a task for GitHub Copilot | 🧰 |
| **Workflows** | Agentic Workflows for AI-powered repository automation | ⚡ |
| **Plugins** | Installable packages of related prompts, agents, or skills | 🎁 |
In addition, all standard contribution types supported by [All Contributors](https://allcontributors.org/emoji-key/) are recognized.