claude-code-action
把 Claude Code 接进 GitHub Actions 的官方 action:通过 @claude 提及、issue 指派或显式 prompt 触发,让 agent 读代码、回答架构问题、审查 PR 并直接提交修改。亮点是能根据 workflow 上下文自动判断该用哪种执行模式,省掉一堆配置;鉴权同时支持 Anthropic API key、workload identity federation、Bedrock、Vertex AI 和 Microsoft Foundry,且任务全程跑在自己的 runner 上,还能输出结构化 JSON 结果接后续自动化流程。MIT 许可。
README

Claude Code Action
一个通用型 Claude Code action,适用于 GitHub PR 和 issue,能够回答问题并实现代码变更。该 action 会根据你的 workflow 上下文智能判断何时激活——无论是响应 @claude 提及、issue 指派,还是通过显式 prompt 执行自动化任务。它支持多种认证方式,包括 Anthropic 直连 API(API key 或 workload identity federation)、Amazon Bedrock、Google Vertex AI 和 Microsoft Foundry。
功能特性
- 🎯 智能模式检测:根据你的 workflow 上下文自动选择合适的执行模式——无需配置
- 🤖 交互式代码助手:Claude 可以回答关于代码、架构和编程的问题
- 🔍 代码审查:分析 PR 变更并提出改进建议
- ✨ 代码实现:可以实现简单修复、重构,甚至新功能
- 💬 PR/Issue 集成:与 GitHub 评论和 PR review 无缝协作
- 🛠️ 灵活的工具访问:可访问 GitHub API 和文件操作(可通过配置启用更多工具)
- 📋 进度跟踪:带有复选框的可视化进度指示器,会随 Claude 完成任务动态更新
- 📊 结构化输出:获取经过校验的 JSON 结果,并自动成为 GitHub Action 输出,适用于复杂自动化场景
- 🏃 运行在你自己的基础设施上:该 action 完全在你自己的 GitHub runner 上执行(Anthropic API 调用会发送到你选择的 provider)
- ⚙️ 简化配置:统一的
prompt和claude_args输入提供了简洁而强大的配置方式,与 Claude Code SDK 保持一致
📦 从 v0.x 升级?
请参阅我们的迁移指南,其中包含将 workflow 更新到 v1.0 的分步说明。新版本在简化配置的同时,仍兼容大多数现有设置。
快速开始
设置此 action 最简单的方式是通过终端中的 Claude Code。只需打开 claude 并运行 /install-github-app。
该命令将引导你完成 GitHub app 和所需 secrets 的设置。
注意:
- 你必须是仓库管理员才能安装 GitHub app 并添加 secrets
- 此快速开始方式仅适用于 Anthropic API 直连用户。如需 AWS Bedrock、Google Vertex AI 或 Microsoft Foundry 的设置,请参阅 docs/cloud-providers.md。
📚 解决方案与用例
在寻找特定的自动化模式?请查看我们的**解决方案指南**,其中包含完整的可用示例,包括:
- 🔍 自动 PR 代码审查 - 完整的 review 自动化
- 📂 按路径审查 - 在关键文件变更时触发
- 👥 外部贡献者审查 - 针对新贡献者的特殊处理
- 📝 自定义审查清单 - 强制执行团队规范
- 🔄 定时维护 - 自动化仓库健康检查
- 🏷️ Issue 分类与打标签 - 自动归类
- 📖 文档同步 - 让文档随代码变更保持更新
- 🔒 安全导向的审查 - 对齐 OWASP 的安全分析
- 📊 自助进度跟踪 - 在自动化模式下创建跟踪评论
每个解决方案都包含完整的可用示例、配置细节和预期结果。
文档
- 解决方案指南 - 🎯 开箱即用的自动化模式
- 迁移指南 - ⭐ 从 v0.x 升级到 v1.0
- 设置指南 - 手动设置、自定义 GitHub apps 和安全最佳实践
- 使用指南 - 基本用法、workflow 配置和输入参数
- 自定义自动化 - 自动化 workflow 和自定义 prompt 示例
- 配置 - MCP servers、权限、环境变量和高级设置
- 实验性特性 - 执行模式和网络限制
- 云服务提供商 - AWS Bedrock、Google Vertex AI 和 Microsoft Foundry 设置
- 能力与限制 - Claude 能做什么、不能做什么
- 安全 - 访问控制、权限和提交签名
- FAQ - 常见问题与故障排查
📚 FAQ
遇到问题或有疑问?请查看我们的常见问题解答,了解常见问题的解决方案,以及关于 Claude 能力与限制的详细说明。
许可证
本项目采用 MIT 许可证——详情请参阅 LICENSE 文件。