GitHub Agentic Workflows(gh-aw)
GitHub Agentic Workflows 让开发者用 Markdown 正文 + YAML frontmatter 定义 AI 驱动的仓库自动化,并通过 gh-aw 这个 GitHub CLI 扩展把每个 agentic workflow 编译成标准 GitHub Actions 工作流,在 GitHub Actions 中安全地运行 AI Agent;内置 GitHub Copilot、Claude Code、OpenAI Codex、Google Gemini、Pi 等 AI 引擎,Agent 任务默认只读且沙箱化,写入通过受校验的 safe-outputs 任务执行。
社区作者 · zZz
它解决什么问题
GitHub Agentic Workflows(gh-aw)= Actions + Agent + Safety,是一个 GitHub CLI 扩展:把 Markdown(带 YAML frontmatter)编写的 agentic workflow 编译为标准 GitHub Actions 工作流,由 AI Agent 执行需要推理或解释的任务。
工作方式:一个 agentic workflow 由两部分组成——YAML frontmatter 配置触发条件(triggers)、权限(permissions)、工具(tools)和 AI 引擎;Markdown 正文告诉 AI Agent 要完成什么。gh aw compile 命令校验该源文件并生成 GitHub Actions 执行的 .lock.yml 工作流。
与常规 CI/CD 的关系:确定性的构建、测试、lint、部署和可复现脚本继续使用常规 GitHub Actions;当任务需要推理或解释时(如 issue 分诊、pull request 审查、CI 失败排查、文档维护、依赖分析、仓库报告)再添加 agentic workflow。GitHub Agentic Workflows 是对现有 CI/CD 的补充,而非替代。
内置 AI 引擎:GitHub Copilot、Claude Code、OpenAI Codex、Google Gemini、Pi。
安全与权限:安全、权限与受控写入是核心设计关注点。支持的 agent 任务路径默认使用只读 GitHub 访问和沙箱化执行;safe outputs 会缓冲配置的写入、进行校验,并在具有限定权限的独立任务中应用。这些控制项可配置,因此工作流作者必须在部署前审查权限、工具、网络访问和生成的文件。使用 agentic workflow 需要仔细考虑安全性并进行人工监督,即便如此仍可能出错,需谨慎并自担风险。
安全提示:来源页面注明在版本 >= 0.83.3、< 0.85.4 中发现了一个安全漏洞,作为预防措施这些发布版本已被下线(retired)。
文档与资源:官方文档覆盖创建 agentic workflow、选择并认证 AI 引擎、按任务浏览示例、审查安全架构、阅读 FAQ 等路径;面向 AI Agent 和检索工具,还提供已发布的 agent prompt index、完整 prompt 语料库和 AI 可读的项目摘要。项目还包含由社区 issue 被解决者构成的自动更新社区贡献者名单(Community Contributions),以及名为 Factory Tour Workshop 的自包含分步工作坊仓库,用于从零学习构建、运行和定制 agentic workflow。
开发与贡献:开发环境搭建与贡献指南见 CONTRIBUTING.md。项目包含自定义 Go linter 的构建与测试流程。
— 本文由 AI 根据公开来源辅助整理,命令、版本与许可证请在使用前到原始页面复核。
安装 / 开始使用
准备环境:需要 GitHub CLI(gh)以及可运行 GitHub Actions 的 GitHub 仓库。
- 安装 GitHub CLI 扩展:
gh extension install github/gh-aw- 随后按 GitHub Agentic Workflows quickstart 操作:选择一个 AI 引擎、添加一个示例 workflow,并通过 GitHub Actions 运行它。
- 编写 agentic workflow:用 YAML frontmatter 配置触发条件、权限、工具和 AI 引擎;用 Markdown 正文描述 AI Agent 要完成的目标。
- 编译校验:运行 gh aw compile 校验源文件并生成 .lock.yml 工作流文件,交由 GitHub Actions 执行。
- 自定义 Go linter 的构建与测试(贡献者/开发者场景):
go test ./pkg/linters/<linter-name>/...go build ./cmd/lintersmake golint-custom其中 make golint-custom 会构建 cmd/linters,并对 ./cmd/... 和 ./pkg/... 运行自定义分析器。
常见问题与注意事项:
- 版本 >= 0.83.3、< 0.85.4 中曾发现安全漏洞,这些发布已被下线,安装时需注意版本选择。
- agent 任务默认只读且沙箱化,写入需通过 safe-outputs 机制;这些控制项可配置,部署前必须人工审查权限、工具、网络访问和生成的文件。
- 使用 agentic workflow 需要谨慎和人工监督,仍可能出现问题,风险自负。
- 使用文档中的创建 workflow、选择并认证 AI 引擎、示例、安全架构与 FAQ 页面获取进一步帮助。
- 开发环境搭建与贡献流程参见 CONTRIBUTING.md。