Skip to content

Commit b9ab43e

Browse files
committed
update README
1 parent 6c3f14a commit b9ab43e

1 file changed

Lines changed: 5 additions & 45 deletions

File tree

README.md

Lines changed: 5 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ Write agentic workflows in natural language markdown, and run them in GitHub Act
1717

1818
- [Quick Start](#quick-start)
1919
- [Overview](#overview)
20-
- [How It Works](#how-it-works)
21-
- [Safe Agentic Workflows](#safe-agentic-workflows)
20+
- [Guardrails](#guardrails)
2221
- [Documentation](#documentation)
2322
- [Contributing](#contributing)
2423
- [Share Feedback](#share-feedback)
@@ -33,61 +32,23 @@ Ready to get your first agentic workflow running? Follow our step-by-step [Quick
3332

3433
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://github.github.io/gh-aw/introduction/how-they-work/).
3534

36-
## How It Works
35+
## Guardrails
3736

38-
GitHub Agentic Workflows transforms natural language markdown files into GitHub Actions that are executed by AI agents. Here's an example:
37+
Guardrails, safety and security are 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 Architecture](https://github.github.com/gh-aw/introduction/architecture/) for comprehensive details on threat modeling, implementation guidelines, and best practices.
3938

40-
```markdown
41-
---
42-
on:
43-
schedule: daily
44-
permissions:
45-
contents: read
46-
issues: read
47-
pull-requests: read
48-
safe-outputs:
49-
create-issue:
50-
title-prefix: "[team-status] "
51-
labels: [report, daily-status]
52-
close-older-issues: true
53-
---
54-
55-
## Daily Issues Report
56-
57-
Create an upbeat daily status report for the team as a GitHub issue.
58-
```
59-
60-
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.
61-
62-
The AI agent reads your repository context, analyzes issues, generates visualizations, and creates reports - all defined in natural language rather than complex code.
63-
64-
## Safety
65-
66-
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 Architecture](https://github.github.com/gh-aw/introduction/architecture/) for comprehensive details on threat modeling, implementation guidelines, and best practices.
67-
68-
> [!WARNING]
69-
> 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.
39+
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.
7040

7141
## Documentation
7242

7343
For complete documentation, examples, and guides, see the [Documentation](https://github.github.com/gh-aw/).
7444

7545
## Contributing
7646

77-
We welcome contributions to GitHub Agentic Workflows! Here's how you can help:
78-
79-
- **Report bugs and request features** by filing issues in this repository
80-
- **Improve documentation** by contributing to our docs
81-
- **Contribute code** by following our [Development Guide](DEVGUIDE.md)
82-
- **Quick Start**: See [Common Development Tasks](DEVGUIDE.md#common-development-tasks) for scenario-based command reference
83-
- **Share ideas** in the `#continuous-ai` channel in the [GitHub Next Discord](https://gh.io/next-discord)
84-
8547
For development setup and contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md).
8648

8749
## Share Feedback
8850

89-
We welcome your feedback on GitHub Agentic Workflows! Please file bugs and feature requests as issues in this repository,
90-
and share your thoughts in the `#continuous-ai` channel in the [GitHub Next Discord](https://gh.io/next-discord).
51+
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 [GitHub Next Discord](https://gh.io/next-discord).
9152

9253
## Peli's Agent Factory
9354

@@ -99,4 +60,3 @@ GitHub Agentic Workflows is supported by companion projects that provide additio
9960

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

0 commit comments

Comments
 (0)