gh-aw

GitHub Agentic Workflows

Agent quick links

Hello fellow agent! Welcome to GitHub Agentic Workflows = Actions + Agent + Safety. Here are some pointers to get you started in using this tool.

• Create a new workflow: https://raw.githubusercontent.com/github/gh-aw/main/create.md
• Install: https://raw.githubusercontent.com/github/gh-aw/main/install.md
• Package a workflow repository: https://raw.githubusercontent.com/github/gh-aw/main/package.md
• Reference: https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/github-agentic-workflows.md

GitHub Agentic Workflows (gh-aw) lets developers define AI-powered repository automation in Markdown with YAML frontmatter and run AI agents securely through GitHub Actions. The gh-aw GitHub CLI extension compiles each agentic workflow into a standard GitHub Actions workflow.

Use conventional GitHub Actions for deterministic builds, tests, linting, deployments, and reproducible scripts. Add an agentic workflow when a task needs reasoning or interpretation, such as issue triage, pull-request review, CI failure investigation, documentation maintenance, dependency analysis, or repository reporting. GitHub Agentic Workflows complements existing CI/CD; it does not replace it.

Built-in AI engines include GitHub Copilot, Claude Code, OpenAI Codex, Google Gemini, and Pi. Agent jobs are read-only and sandboxed by default, and configured GitHub writes are normally applied through validated safe-outputs jobs with scoped permissions.

Contents

• Quick Start
• How Agentic Workflows work
• Security and permissions
• Documentation
• Contributing
• Community Contributions
• Related Projects
• Workshop

Note A security vulnerability was discovered in versions >= 0.83.3, < 0.85.4 and, as a result, those releases were retired as a pre-emptive measure.

Quick Start

Install the GitHub CLI extension:

gh extension install github/gh-aw

Then follow the GitHub Agentic Workflows quickstart to select an AI engine, add a sample workflow, and run it through GitHub Actions.

How Agentic Workflows work

An agentic workflow has two parts: YAML frontmatter configures triggers, permissions, tools, and the AI engine; the Markdown body tells the AI agent what to accomplish. The gh aw compile command validates this source and generates the .lock.yml workflow that GitHub Actions executes. Learn how GitHub Agentic Workflows works.

Security and permissions

Security, permissions, and controlled writes are core design concerns. The supported agent-job path defaults to read-only GitHub access and sandboxed execution. Safe outputs buffer configured writes, validate them, and apply them in separate jobs with scoped permissions. These controls are configurable, so workflow authors must review permissions, tools, network access, and generated files before deployment. Learn how GitHub Agentic Workflows handles security and permissions.

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.

Documentation

Use the GitHub Agentic Workflows documentation for these paths:

• Create an agentic workflow
• Choose and authenticate an AI engine
• Browse GitHub Agentic Workflows examples by task
• Review the security architecture
• Read the GitHub Agentic Workflows FAQ

For AI agents and retrieval tools, use the published agent prompt index, full prompt corpus, and AI-readable project summary.

Contributing

For development setup and contribution guidelines, see CONTRIBUTING.md.

Custom Go linters

To build and test repository custom linters:

• go test ./pkg/linters/<linter-name>/...
• go build ./cmd/linters
• make golint-custom

make golint-custom builds cmd/linters and runs the custom analyzers against ./cmd/... and ./pkg/....

🌍 Community Contributions

Community members whose issues were resolved — updated automatically.

@a-sjogren-accenture (2) @aaronspindler (1) @abbottships (3) @abillingsley (2) @adam-cobb (1) @adamhenson (2) @adamtasteslikegood (1) @Adarsh1999 (1) @adhikjoshi (1) @aharper-srsacquiom (1) @ahmadabdalla (1) @ajfeldman6 (1) @akkikumar72 (1) @AkshatRaj00 (1) @alanpeabody (1) @alcastaneda (1) @AlexanderWert (1) @AlexDeMichieli (1) @alexsiilvaa (2) @alirezamirian (1) @alondahari (18) @alvistar (2) @AmoebaChant (1) @AnandhaSivam-00 (1) @anthonyhull-ford (2) @anthonymastreanvae (11) @aoxiangtianyu-go (1) @apenab (1) @arabkin (1) @arezero (6) @Arithmomaniac (1) @arthurfvives (8) @Artur- (1) @asatara (1) @askpaisa (1) @askpt (1) @astefan (1) @awoisoak (1) @b-dantas (1) @b2pacific (1) @babaakihiro (2) @bartul (1) @bbonafed (23) @beardofedu (1) @beingminimal (1) @benissimo (18) @BenjaminMichaelis (1) @benvillalobos (12) @bindsi (1) @bjartenilsen (1) @blavity-machine-user (1) @blozano-tt (11) @bmerkle (3) @boydj (2) @Bra1nFartz (1) @BrandonLewis (1) @brendanlapuma (1)