mirror of
https://github.com/github/awesome-copilot.git
synced 2026-03-12 04:05:12 +00:00
43 lines
3.0 KiB
Markdown
43 lines
3.0 KiB
Markdown
# ⚡ 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 event-triggered and scheduled automation with built-in guardrails and security-first design.
|
|
### How to Contribute
|
|
|
|
See [CONTRIBUTING.md](../CONTRIBUTING.md#adding-agentic-workflows) for guidelines on how to contribute new workflows, improve existing ones, and share your use cases.
|
|
|
|
### How to Use Agentic Workflows
|
|
|
|
**What's Included:**
|
|
- Each workflow is a single `.md` file with YAML frontmatter and natural language instructions
|
|
- Workflows are compiled to `.lock.yml` GitHub Actions files via `gh aw compile`
|
|
- Workflows follow the [GitHub Agentic Workflows specification](https://github.github.com/gh-aw)
|
|
|
|
**To Install:**
|
|
- Install the `gh aw` CLI extension: `gh extension install github/gh-aw`
|
|
- Copy the workflow `.md` file to your repository's `.github/workflows/` directory
|
|
- Compile with `gh aw compile` to generate the `.lock.yml` file
|
|
- Commit both the `.md` and `.lock.yml` files
|
|
|
|
**To Activate/Use:**
|
|
- Workflows run automatically based on their configured triggers (schedules, events, slash commands)
|
|
- Use `gh aw run <workflow>` to trigger a manual run
|
|
- Monitor runs with `gh aw status` and `gh aw logs`
|
|
|
|
**When to Use:**
|
|
- Automate issue triage and labeling
|
|
- Generate daily status reports
|
|
- Maintain documentation automatically
|
|
- Run scheduled code quality checks
|
|
- Respond to slash commands in issues and PRs
|
|
- Orchestrate multi-step repository automation
|
|
|
|
| Name | Description | Triggers |
|
|
| ---- | ----------- | -------- |
|
|
| [Daily Issues Report](../workflows/daily-issues-report.md) | Generates a daily summary of open issues and recent activity as a GitHub issue | schedule |
|
|
| [OSPO Contributors Report](../workflows/ospo-contributors-report.md) | Monthly contributor activity metrics across an organization's repositories. | schedule, workflow_dispatch |
|
|
| [OSPO Organization Health Report](../workflows/ospo-org-health.md) | Comprehensive weekly health report for a GitHub organization. Surfaces stale issues/PRs, merge time analysis, contributor leaderboards, and actionable items needing human attention. | schedule, workflow_dispatch |
|
|
| [OSPO Stale Repository Report](../workflows/ospo-stale-repos.md) | Identifies inactive repositories in your organization and generates an archival recommendation report. | schedule, workflow_dispatch |
|
|
| [OSS Release Compliance Checker](../workflows/ospo-release-compliance-checker.md) | Analyzes a target repository against open source release requirements and posts a detailed compliance report as an issue comment. | issues, workflow_dispatch |
|
|
| [Relevance Check](../workflows/relevance-check.md) | Slash command to evaluate whether an issue or pull request is still relevant to the project | slash_command, roles |
|
|
| [Relevance Summary](../workflows/relevance-summary.md) | Manually triggered workflow that summarizes all open issues and PRs with a /relevance-check response into a single issue | workflow_dispatch |
|