Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
232 changes: 177 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,18 @@
# GitHub Agentic Workflows
# πŸ€– GitHub Agentic Workflows

Write agentic workflows in natural language markdown, and run them in GitHub Actions.
> **Transform natural language into powerful AI-driven automation for your repositories**

<!--
> [!NOTE]
> **For AI Agents**: To learn about GitHub Agentic Workflows syntax, file formats, tools, and best practices, please read the comprehensive instructions at: [.github/aw/github-agentic-workflows.md](https://raw.githubusercontent.com/githubnext/gh-aw/main/.github/aw/github-agentic-workflows.md)
>
> **Custom Agent**: Use the custom agent at `.github/agents/create-agentic-workflow.md` to interactively create agentic workflows. The custom agent is available at: [.github/agents/create-agentic-workflow.md](https://raw.githubusercontent.com/githubnext/gh-aw/main/.github/agents/create-agentic-workflow.md)
-->
Write agentic workflows in simple markdown and run them as GitHub Actionsβ€”no complex code required. Let AI agents handle the heavy lifting: analyzing issues, generating reports, reviewing PRs, and automating repository tasks.

## Contents
[![Documentation](https://img.shields.io/badge/docs-githubnext.github.io-blue)](https://githubnext.github.io/gh-aw/)
[![GitHub Next](https://img.shields.io/badge/GitHub-Next-purple)](https://githubnext.com/)
[![Discord](https://img.shields.io/badge/Discord-continuous--ai-5865F2)](https://gh.io/next-discord)

- [Quick Start](#quick-start)
- [Overview](#overview)
- [How It Works](#how-it-works)
- [Safe Agentic Workflows](#safe-agentic-workflows)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [Share Feedback](#share-feedback)
- [Agent Factory](#agent-factory)
- [Related Projects](#related-projects)

## Quick Start

Ready to get your first agentic workflow running? Follow our step-by-step [Quick Start Guide](https://githubnext.github.io/gh-aw/setup/quick-start/) to install the extension, add a sample workflow, and see it in action.

## Overview

Learn about the concepts behind agentic workflows, explore available workflow types, and understand how AI can automate your repository tasks. See [How It Works](https://githubnext.github.io/gh-aw/introduction/how-it-works/).
---

## How It Works
## πŸš€ Quick Example

GitHub Agentic Workflows transforms natural language markdown files into GitHub Actions that are executed by AI agents. Here's an example:
Transform this simple markdown:

```markdown
---
Expand All @@ -40,59 +21,200 @@ on:
permissions:
contents: read
issues: read
pull-requests: read
safe-outputs:
create-issue:
title-prefix: "[team-status] "
labels: [report, daily-status]
close-older-issues: true
---

## Daily Issues Report

Create an upbeat daily status report for the team as a GitHub issue.
```

The `gh aw` cli converts this into a GitHub Actions Workflow (.yml) that runs an AI agent (Copilot, Claude, Codex, ...) in a containerized environment on a schedule or manually.
Into a fully automated AI workflow that:
- πŸ” Analyzes your repository's issues
- πŸ“Š Generates insights and visualizations
- ✍️ Creates well-formatted reports
- 🎯 Posts them as GitHub issuesβ€”all hands-free!

## ✨ Why GitHub Agentic Workflows?

<table>
<tr>
<td width="33%" valign="top">

### 🎯 **Simple to Use**

Write workflows in plain English markdownβ€”no complex code or APIs to learn. If you can write a GitHub issue, you can create an agentic workflow.

</td>
<td width="33%" valign="top">

### πŸ”’ **Security First**

Built with multiple layers of protection: sandboxed execution, read-only by default, validated safe-outputs, and supply chain security with SHA-pinned dependencies.

</td>
<td width="33%" valign="top">

### ⚑ **Powerful & Flexible**

Choose from multiple AI engines (Copilot, Claude, Codex), integrate with tools and APIs, and extend with custom actionsβ€”all within GitHub's familiar environment.

</td>
</tr>
</table>

## 🎬 Get Started in 3 Steps

### 1️⃣ Install the CLI Extension

```bash
gh extension install githubnext/gh-aw
```

### 2️⃣ Create Your First Workflow

```bash
gh aw new my-first-workflow.md
```

### 3️⃣ Compile and Run

```bash
gh aw compile my-first-workflow.md
git add . && git commit -m "Add agentic workflow" && git push
```

πŸŽ‰ **That's it!** Your AI agent is now running on GitHub Actions.

πŸ‘‰ **[Full Quick Start Guide](https://githubnext.github.io/gh-aw/setup/quick-start/)**

## πŸ“š What Can You Build?

<details>
<summary><b>πŸ“Š Automated Status Reports</b></summary>

The AI agent reads your repository context, analyzes issues, generates visualizations, and creates reports - all defined in natural language rather than complex code.
Generate daily, weekly, or on-demand reports about repository activity, pull request status, issue trends, and team productivity.

## Safe Agentic Workflows
</details>

Security is foundational to GitHub Agentic Workflows. Workflows run with read-only permissions by default, with write operations only allowed through sanitized `safe-outputs`. The system implements multiple layers of protection including sandboxed execution, input sanitization, network isolation, supply chain security (SHA-pinned dependencies), tool allow-listing, and compile-time validation. Access can be gated to team members only, with human approval gates for critical operations, ensuring AI agents operate safely within controlled boundaries. See the [Security Guide](https://githubnext.github.io/gh-aw/guides/security/) for comprehensive details on threat modeling, implementation guidelines, and best practices.
<details>
<summary><b>πŸ” PR Review Assistant</b></summary>

Automatically review pull requests for code quality, security issues, documentation completeness, and adherence to coding standards.

</details>

<details>
<summary><b>πŸ› Bug Triage &amp; Analysis</b></summary>

Analyze incoming issues, categorize bugs, detect duplicates, suggest labels, and route to appropriate team members.

</details>

<details>
<summary><b>πŸ“ Documentation Generator</b></summary>

Keep documentation up-to-date by analyzing code changes and automatically updating relevant docs, READMEs, and API references.

</details>

<details>
<summary><b>🎯 Project Management</b></summary>

Update project boards, track milestones, generate burndown charts, and send status updates based on repository activity.

</details>

<details>
<summary><b>πŸ” Security Scanning</b></summary>

Scan for security vulnerabilities, check dependencies, validate configurations, and create security advisories automatically.

</details>

**🌟 See more examples:** [Peli's Agent Factory](https://githubnext.github.io/gh-aw/blog/2026-01-12-welcome-to-pelis-agent-factory/)

## πŸ›‘οΈ Safe Agentic Workflows

Security isn't an afterthoughtβ€”it's foundational:

- πŸ” **Read-only by default** - Agents never get write permissions
- βœ… **Validated safe-outputs** - All write operations sanitized and validated
- πŸ“¦ **Sandboxed execution** - Isolated containerized environment
- πŸ”’ **Network isolation** - Control exactly what agents can access
- πŸ“Œ **Supply chain security** - SHA-pinned dependencies
- πŸ› οΈ **Tool allow-listing** - Explicit tool permissions
- βœ”οΈ **Compile-time validation** - Catch issues before deployment

> [!WARNING]
> Using agentic workflows in your repository requires careful attention to security considerations and careful human supervision, and even then things can still go wrong. Use it with caution, and at your own risk.
> Using agentic workflows requires careful attention to security considerations and human supervision. Use with caution and at your own risk.

**πŸ“– [Security Guide](https://githubnext.github.io/gh-aw/guides/security/)**

## 🎨 Key Features

| Feature | Description |
|---------|-------------|
| **πŸ€– Multiple AI Engines** | Choose from GitHub Copilot, Claude, Codex, or custom engines |
| **πŸ”§ Extensible Tools** | Integrate with GitHub API, MCP servers, and custom tools |
| **🌐 Network Control** | Domain-restricted access with firewall integration |
| **🎭 Browser Automation** | Built-in Playwright for web scraping and testing |
| **πŸ“ Safe Outputs** | Create issues, PRs, comments without write permissions |
| **⚑ Event-Driven** | Trigger on push, issues, PRs, schedules, or manual dispatch |
| **πŸ“Š Rich Context** | Access repository data, files, issues, and PRs |
| **πŸ”„ Custom Actions** | Build reusable workflow components |

## πŸ“– Documentation

## Documentation
- **[Quick Start Guide](https://githubnext.github.io/gh-aw/setup/quick-start/)** - Get up and running in minutes
- **[How It Works](https://githubnext.github.io/gh-aw/introduction/how-it-works/)** - Understand the concepts
- **[Safe Outputs Reference](https://githubnext.github.io/gh-aw/reference/safe-outputs/)** - Learn about validated operations
- **[Security Guide](https://githubnext.github.io/gh-aw/guides/security/)** - Security best practices
- **[Complete Documentation](https://githubnext.github.io/gh-aw/)** - Full reference and guides

For complete documentation, examples, and guides, see the [Documentation](https://githubnext.github.io/gh-aw/).
## 🀝 Contributing

## Contributing
We welcome contributions! Here's how you can help:

We welcome contributions to GitHub Agentic Workflows! Here's how you can help:
- πŸ› **Report bugs** - File issues in this repository
- πŸ’‘ **Request features** - Share your ideas
- πŸ“ **Improve docs** - Help others learn
- πŸ’» **Contribute code** - See our [Development Guide](DEVGUIDE.md)
- πŸ’¬ **Share ideas** - Join `#continuous-ai` in the [GitHub Next Discord](https://gh.io/next-discord)

- **Report bugs and request features** by filing issues in this repository
- **Improve documentation** by contributing to our docs
- **Contribute code** by following our [Development Guide](DEVGUIDE.md)
- **Quick Start**: See [Common Development Tasks](DEVGUIDE.md#common-development-tasks) for scenario-based command reference
- **Share ideas** in the `#continuous-ai` channel in the [GitHub Next Discord](https://gh.io/next-discord)
**Development Setup:** [CONTRIBUTING.md](CONTRIBUTING.md)

For development setup and contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md).
## πŸ’¬ Share Feedback

## Share Feedback
We'd love to hear from you!

We welcome your feedback on GitHub Agentic Workflows! Please file bugs and feature requests as issues in this repository,
and share your thoughts in the `#continuous-ai` channel in the [GitHub Next Discord](https://gh.io/next-discord).
- πŸ“ **File issues** - Report bugs or request features
- πŸ’¬ **Join Discord** - Chat in `#continuous-ai` at [GitHub Next Discord](https://gh.io/next-discord)
- 🌟 **Star the repo** - Show your support

## Peli's Agent Factory
## 🏭 Peli's Agent Factory

Take a guided tour through creative uses of agentic workflows, from simple automations to complex multi-agent systems.

**[Visit Peli's Agent Factory β†’](https://githubnext.github.io/gh-aw/blog/2026-01-12-welcome-to-pelis-agent-factory/)**

## πŸ”— Related Projects

GitHub Agentic Workflows is supported by companion projects:

- **[Agent Workflow Firewall (AWF)](https://github.com/githubnext/gh-aw-firewall)** - Network egress control with domain-based access controls and activity logging
- **[MCP Gateway](https://github.com/githubnext/gh-aw-mcpg)** - Routes MCP server calls through a unified HTTP gateway for centralized management
- **[The Agentics](https://github.com/githubnext/agentics)** - Reusable agentic workflow components, tools, and templates

---

See the [Peli's Agent Factory](https://githubnext.github.io/gh-aw/blog/2026-01-12-welcome-to-pelis-agent-factory/) for a guided tour through many uses of agentic workflows.
<div align="center">

## Related Projects
**Built with ❀️ by [GitHub Next](https://githubnext.com/)**

GitHub Agentic Workflows is supported by companion projects that provide additional security and integration capabilities:
[Documentation](https://githubnext.github.io/gh-aw/) β€’ [Quick Start](https://githubnext.github.io/gh-aw/setup/quick-start/) β€’ [Security](https://githubnext.github.io/gh-aw/guides/security/) β€’ [Discord](https://gh.io/next-discord)

- **[Agent Workflow Firewall (AWF)](https://github.com/githubnext/gh-aw-firewall)** - Network egress control for AI agents, providing domain-based access controls and activity logging for secure workflow execution
- **[MCP Gateway](https://github.com/githubnext/gh-aw-mcpg)** - Routes Model Context Protocol (MCP) server calls through a unified HTTP gateway for centralized access management
- **[The Agentics](https://github.com/githubnext/agentics)** - A collection of reusable agentic workflow components, tools, and templates to accelerate workflow development
</div>
Loading