Claude Code Action

一个通用的 Claude Code GitHub 操作，适用于 Pull Request 和 Issues，能够回答问题并实施代码更改。此操作可根据工作流上下文智能检测何时激活——无论是响应 @claude 提及、Issue 分配，还是通过显式提示执行自动化任务。它支持多种身份验证方式，包括 Anthropic 直接 API、Amazon Bedrock、Google Vertex AI 和 Microsoft Foundry。

特性

• 🎯 智能模式检测：根据工作流上下文自动选择适当的执行模式，无需配置
• 🤖 交互式代码助手：Claude 可以回答关于代码、架构和编程的问题
• 🔍 代码审查：分析 PR 的更改并提出改进建议
• ✨ 代码实现：可以实现简单的修复、重构，甚至新功能
• 💬 PR/Issue 集成：与 GitHub 评论和 PR 审查无缝集成
• 🛠️ 灵活的工具访问：可访问 GitHub API 和文件操作（可通过配置启用其他工具）
• 📋 进度跟踪：带有复选框的可视化进度指示器，会在 Claude 完成任务时动态更新
• 📊 结构化输出：获取经过验证的 JSON 结果，这些结果会自动成为 GitHub Action 的输出，用于复杂的自动化流程
• 🏃 在您的基础设施上运行：该操作完全在您自己的 GitHub runner 上执行（Anthropic API 调用将发送到您选择的提供商）
• ⚙️ 简化配置：统一的 prompt 和 claude_args 输入提供了简洁而强大的配置，与 Claude Code SDK 保持一致

📦 从 v0.x 升级？

请参阅我们的 迁移指南，其中包含将您的工作流升级到 v1.0 的分步说明。新版本简化了配置，同时保持与大多数现有设置的兼容性。

快速入门

设置此操作最简单的方式是通过终端中的 Claude Code。只需打开 claude 并运行 /install-github-app。

此命令将引导您完成 GitHub 应用程序和所需密钥的设置。

注意：

• 您必须是仓库管理员才能安装 GitHub 应用程序并添加密钥
• 此快速入门方法仅适用于直接使用 Anthropic API 的用户。对于 AWS Bedrock、Google Vertex AI 或 Microsoft Foundry 的设置，请参阅 docs/cloud-providers.md。

📚 解决方案与用例

正在寻找特定的自动化模式？请查看我们的 解决方案指南，其中包含完整的示例，包括：

• 🔍 自动 PR 代码审查 - 全面审查自动化
• 📂 基于路径的审查 - 在关键文件更改时触发
• 👥 外部贡献者审查 - 对新贡献者的特殊处理
• 📝 自定义审查清单 - 强制执行团队标准
• 🔄 定期维护 - 自动化的仓库健康检查
• 🏷️ Issue 分类与标记 - 自动分类
• 📖 文档同步 - 使文档与代码更改保持同步
• 🔒 安全导向的审查 - 符合 OWASP 标准的安全分析
• 📊 自定义进度跟踪 - 在自动化模式下创建跟踪评论

每个解决方案都包含完整的示例、配置细节以及预期结果。

文档

• 解决方案指南 - 🎯 开箱即用的自动化模式
• 迁移指南 - ⭐ 从 v0.x 升级到 v1.0
• 设置指南 - 手动设置、自定义 GitHub 应用程序以及安全最佳实践
• 使用指南 - 基本用法、工作流配置和输入参数
• 自定义自动化 - 自动化工作流和自定义提示的示例
• 配置 - MCP 服务器、权限、环境变量和高级设置
• 实验性功能 - 执行模式和网络限制
• 云提供商 - AWS Bedrock、Google Vertex AI 和 Microsoft Foundry 的设置
• 能力与限制 - Claude 能做什么，不能做什么
• 安全 - 访问控制、权限和提交签名
• 常见问题解答 - 常见问题及故障排除

📚 常见问题解答

遇到问题或有疑问吗？请查看我们的 常见问题解答，其中包含常见问题的解决方案以及对 Claude 功能和限制的详细解释。

许可证

本项目采用 MIT 许可证授权——详情请参阅 LICENSE 文件。

Claude Code Action 快速上手指南

环境准备

在开始之前，请确保满足以下前置条件：

• GitHub 权限：你需要拥有目标仓库的 管理员 (Admin) 权限，以便安装 GitHub App 和配置 Secrets。
• API 凭证：
  • 推荐方式：拥有 Anthropic API Key（适用于直接调用）。
  • 替代方案：若使用 AWS Bedrock、Google Vertex AI 或 Microsoft Foundry，需提前配置好相应的云厂商凭证。
• 本地工具：已安装 Claude Code 命令行工具。

注意：本指南的快速安装流程主要面向直接使用 Anthropic API 的用户。若需配置国内云厂商或特定私有化部署，请参考官方文档中的云提供商章节。

安装步骤

最简便的安装方式是通过终端使用 Claude Code 自动完成 GitHub App 的安装与密钥配置。

1. 打开终端，启动 Claude Code：

   claude
   

2. 在交互界面中运行以下命令：

   /install-github-app
   

3. 按照屏幕提示完成以下操作：

   • 授权创建/安装 GitHub App。
   • 自动将所需的 API Keys 添加为仓库的 Secrets。

安装完成后，工作流即可自动检测上下文（如 @claude 提及、Issue 指派等）并触发执行。

基本使用

安装完成后，无需额外编写复杂的 YAML 配置，直接在 GitHub 的 Pull Request 或 Issue 评论中与 Claude 交互即可。

场景一：代码问答与审查

在 PR 或 Issue 的评论区直接提及 @claude 并输入指令：

@claude 请审查本次提交的代码，重点检查是否存在潜在的空指针异常，并给出优化建议。

场景二：自动化工作流触发

你可以在 .github/workflows 中定义简单的触发器，利用其智能模式检测功能。以下是一个基础的示例片段（通常安装脚本会自动生成默认配置）：

name: Claude Code Automation

on:
  issue_comment:
    types: [created]
  pull_request_review_comment:
    types: [created]

jobs:
  claude-code:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
      issues: write
      id-token: write # 用于 OIDC 认证（如需）
    steps:
      - name: Run Claude Code Action
        uses: anthropics/claude-code-action@v1
        with:
          # 可选：显式指定 prompt，若不填则自动根据评论上下文执行
          # prompt: "Fix the bug described in the issue"
          
          # 可选：传递额外的 Claude 参数
          # claude_args: "--max-tokens 4096"

核心特性说明

• 智能激活：系统会自动判断是回答疑问、审查代码还是执行修改，无需手动切换模式。
• 进度可视化：Claude 在执行长任务时，会在评论中通过复选框动态更新进度。
• 安全执行：所有代码执行均发生在你的 GitHub Runner 上，API 调用直达你配置的提供商，数据可控。