注意
GitHub代理工作流 are in 公开预览 and subject to change.
介绍
GitHub代理工作流 允许使用 AI 支持的工作流自动执行存储库任务。 如需查看 GitHub代理工作流 的概述,请参阅 关于GitHub代理工作流。
本指南将预先生成的代理工作流(每日存储库状态报告)添加到现有存储库。 这大约需要 10 分钟,并让你获得一个在 GitHub Actions 中运行的自动化代理可运行示例。
本快速入门指南重点介绍如何运行你的第一个工作流。 有关更深入的设置和故障排除指南,请参阅 GitHub代理工作流 文档网站。
Prerequisites
在开始之前,请确保具备:
-
AI 帐户:GitHub Copilot、Anthropic Claude、OpenAI Codex 或 Google Gemini
-
GitHub具有写入访问权限的存储库
-
GitHub Actions 已为存储库启用
-
GitHub CLI(
gh)已安装 v2.0.0 或更高版本,并已通过身份验证若要检查版本,请运行
gh --version。 若要进行身份验证,请运行:gh auth login --scopes repo,workflow
您可以使用任何受支持的引擎完成本快速入门指南。 GitHub Copilot 是默认引擎,只有在您选择 GitHub Copilot 方案时才需要该方案。
支持的操作系统是 Linux、macOS 和 WSL Windows。
步骤 1:安装 gh aw 扩展
为 GitHub代理工作流 安装 GitHub CLI 扩展:
gh extension install github/gh-aw
步骤 2:添加工作流并触发运行
从存储库根目录运行:
gh aw add-wizard githubnext/agentics/daily-repo-status
该 add-wizard 命令接受 OWNER/REPO/WORKFLOW-NAME 格式的工作流引用。 此交互式过程将:
- 检查存储库先决条件。
- 提示选择 AI 引擎(Copilot 默认为或从其他引擎中进行选择)。
- 指导你完成所选引擎的机密和身份验证设置。 根据你选择的引擎,向导可能会提示你配置
COPILOT_GITHUB_TOKEN、ANTHROPIC_API_KEY或OPENAI_API_KEY``GEMINI_API_KEY。 有关设置说明,请参阅 身份验证参考 文章。 - 生成工作流 markdown 文件并编译相应的
.lock.yml文件。 - 创建一个拉取请求,在
.github/workflows/中添加这两个生成的文件。 - 让你自行审查并合并拉取请求,或选择一个由系统为你完成合并的流程。
创建工作流后,系统会询问是否要立即运行它。 选择 “是 ”以触发工作流。
步骤 3:等待工作流完成
自动化工作流运行通常需要 2-3 分钟。 完成后,存储库中会显示一个新问题,其中包含分析的每日状态报告:
- 最近的存储库活动(问题、拉取请求、讨论、发布)
- 进度跟踪和亮点
- 维护者的可操作后续步骤
步骤 4:自定义工作流(可选)
可以编辑工作流以匹配优先级:
-
在存储库中打开
.github/workflows/daily-repo-status.md。 -
编辑 Markdown 正文,描述报表要涵盖的内容 - 问题积压工作、CI 设置、测试、性能或路线图。
-
如果更改了 frontmatter 配置,请重新编译工作流:
gh aw compile -
提交并推送你的更改。
-
可选择触发另一次运行:
gh aw run daily-repo-status
后续步骤
- 若要创建自定义 代理工作流,请参阅 创建GitHub代理工作流。
- 有关高级模式和完整参考,请参阅 GitHub代理工作流 文档网站。