Claude Code GitHub Actions

了解如何将 Claude Code 集成到您的开发工作流中，使用 Claude Code GitHub Actions

Claude Code GitHub Actions 为您的 GitHub 工作流带来了 AI 驱动的自动化。只需在任何 PR 或 issue 中简单地提及 @claude，Claude 就可以分析您的代码、创建拉取请求、实现功能和修复错误 - 所有这些都遵循您项目的标准。如需在每个 PR 上自动发布评论而无需触发器，请参阅 GitHub Code Review。

为什么使用 Claude Code GitHub Actions？

• 即时 PR 创建：描述您需要什么，Claude 会创建一个包含所有必要更改的完整 PR
• 自动化代码实现：通过单个命令将 issue 转换为可工作的代码
• 遵循您的标准：Claude 尊重您的 CLAUDE.md 指南和现有代码模式
• 简单设置：通过我们的安装程序和 API 密钥在几分钟内开始使用
• 默认安全：您的代码保留在 Github 的运行器上

Claude 可以做什么？

Claude Code 提供了一个强大的 GitHub Action，改变了您处理代码的方式：

Claude Code Action

这个 GitHub Action 允许您在 GitHub Actions 工作流中运行 Claude Code。您可以使用它在 Claude Code 之上构建任何自定义工作流。

查看仓库 →

设置

快速设置

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

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

手动设置

如果 /install-github-app 命令失败或您更喜欢手动设置，请按照以下手动设置说明进行操作：

1. 安装 Claude GitHub 应用到您的仓库：https://github.com/apps/claude

   Claude GitHub 应用需要以下仓库权限：

   • Contents：读写（用于修改仓库文件）
   • Issues：读写（用于响应 issue）
   • Pull requests：读写（用于创建 PR 和推送更改）

   有关安全和权限的更多详情，请参阅 安全文档。

2. 添加 ANTHROPIC_API_KEY 到您的仓库密钥（了解如何在 GitHub Actions 中使用密钥）

3. 复制工作流文件从 examples/claude.yml 到您的仓库的 .github/workflows/

从 Beta 升级

如果您当前使用 Claude Code GitHub Actions 的 beta 版本，我们建议您更新工作流以使用 GA 版本。新版本简化了配置，同时添加了强大的新功能，如自动模式检测。

基本更改

所有 beta 用户必须对其工作流文件进行这些更改才能升级：

1. 更新 action 版本：将 @beta 更改为 @v1
2. 删除模式配置：删除 mode: "tag" 或 mode: "agent"（现在自动检测）
3. 更新提示输入：将 direct_prompt 替换为 prompt
4. 移动 CLI 选项：将 max_turns、model、custom_instructions 等转换为 claude_args

重大更改参考

前后示例

Beta 版本：

- uses: anthropics/claude-code-action@beta
  with:
    mode: "tag"
    direct_prompt: "Review this PR for security issues"
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
    custom_instructions: "Follow our coding standards"
    max_turns: "10"
    model: "claude-sonnet-4-6"

GA 版本 (v1.0)：

- uses: anthropics/claude-code-action@v1
  with:
    prompt: "Review this PR for security issues"
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
    claude_args: |
      --append-system-prompt "Follow our coding standards"
      --max-turns 10
      --model claude-sonnet-4-6

示例用例

Claude Code GitHub Actions 可以帮助您完成各种任务。examples 目录包含针对不同场景的现成工作流。

基本工作流

name: Claude Code
on:
  issue_comment:
    types: [created]
  pull_request_review_comment:
    types: [created]
jobs:
  claude:
    runs-on: ubuntu-latest
    steps:
      - uses: anthropics/claude-code-action@v1
        with:
          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
          # Responds to @claude mentions in comments

使用 skills

prompt 输入接受 skill 调用以及纯文本：

• 对于存储库的 .claude/skills/ 目录中的 skill，在操作步骤之前运行 actions/checkout，然后传递 /skill-name。
• 对于打包在插件中的 skill，使用 plugin_marketplaces 和 plugins 输入安装插件，然后传递命名空间的 /plugin-name:skill-name。

以下工作流安装 code-review 插件并在每个新的或更新的拉取请求上运行其 skill：

name: Code Review
on:
  pull_request:
    types: [opened, synchronize]
jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - uses: anthropics/claude-code-action@v1
        with:
          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
          plugin_marketplaces: "https://github.com/anthropics/claude-code.git"
          plugins: "code-review@claude-code-plugins"
          prompt: "/code-review:code-review ${{ github.repository }}/pull/${{ github.event.pull_request.number }}"

使用提示的自定义自动化

name: Daily Report
on:
  schedule:
    - cron: "0 9 * * *"
jobs:
  report:
    runs-on: ubuntu-latest
    steps:
      - uses: anthropics/claude-code-action@v1
        with:
          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
          prompt: "Generate a summary of yesterday's commits and open issues"
          claude_args: "--model opus"

常见用例

在 issue 或 PR 评论中：

@claude implement this feature based on the issue description
@claude how should I implement user authentication for this endpoint?
@claude fix the TypeError in the user dashboard component

Claude 将自动分析上下文并做出适当的响应。

最佳实践

CLAUDE.md 配置

在您的仓库根目录创建一个 CLAUDE.md 文件来定义代码风格指南、审查标准、项目特定规则和首选模式。此文件指导 Claude 对您的项目标准的理解。

安全考虑

有关全面的安全指导，包括权限、身份验证和最佳实践，请参阅 Claude Code Action 安全文档。

始终为 API 密钥使用 GitHub Secrets：

• 将您的 API 密钥添加为名为 ANTHROPIC_API_KEY 的仓库密钥
• 在工作流中引用它：anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
• 将 action 权限限制为仅必要的权限
• 在合并前审查 Claude 的建议

始终使用 GitHub Secrets（例如，${{ secrets.ANTHROPIC_API_KEY }}）而不是直接在工作流文件中硬编码 API 密钥。

优化性能

使用 issue 模板提供上下文，保持您的 CLAUDE.md 简洁和专注，并为您的工作流配置适当的超时。

CI 成本

使用 Claude Code GitHub Actions 时，请注意相关成本：

GitHub Actions 成本：

• Claude Code 在 GitHub 托管的运行器上运行，这会消耗您的 GitHub Actions 分钟数
• 有关详细的定价和分钟限制，请参阅 GitHub 的计费文档

API 成本：

• 每次 Claude 交互都会根据提示和响应的长度消耗 API 令牌
• 令牌使用量因任务复杂性和代码库大小而异
• 有关当前令牌费率，请参阅 Claude 的定价页面

成本优化提示：

• 使用特定的 @claude 命令来减少不必要的 API 调用
• 在 claude_args 中配置适当的 --max-turns 以防止过度迭代
• 设置工作流级别的超时以避免失控的作业
• 考虑使用 GitHub 的并发控制来限制并行运行

配置示例

Claude Code Action v1 使用统一参数简化了配置：

- uses: anthropics/claude-code-action@v1
  with:
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
    prompt: "Your instructions here" # Optional
    claude_args: "--max-turns 5" # Optional CLI arguments

关键功能：

• 统一提示界面 - 对所有说明使用 prompt
• Skills - 直接从提示调用已安装的 skills
• CLI 传递 - 通过 claude_args 的任何 Claude Code CLI 参数
• 灵活的触发器 - 适用于任何 GitHub 事件

访问 examples 目录获取完整的工作流文件。

使用 Amazon Bedrock 和 Google Vertex AI

对于企业环境，您可以将 Claude Code GitHub Actions 与您自己的云基础设施一起使用。这种方法让您可以控制数据驻留和计费，同时保持相同的功能。

前置条件

在使用云提供商设置 Claude Code GitHub Actions 之前，您需要：

对于 Google Cloud Vertex AI：

1. 启用了 Vertex AI 的 Google Cloud 项目
2. 为 GitHub Actions 配置的工作负载身份联合
3. 具有所需权限的服务账户
4. GitHub 应用（推荐）或使用默认 GITHUB_TOKEN

对于 Amazon Bedrock：

1. 启用了 Amazon Bedrock 的 AWS 账户
2. 在 AWS 中配置的 GitHub OIDC 身份提供商
3. 具有 Bedrock 权限的 IAM 角色
4. GitHub 应用（推荐）或使用默认 GITHUB_TOKEN

name: Claude PR Action

permissions:
contents: write
pull-requests: write
issues: write
id-token: write

on:
issue_comment:
types: [created]
pull_request_review_comment:
types: [created]
issues:
types: [opened, assigned]

jobs:
claude-pr:
if: |
(github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude')) ||
(github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude')) ||
(github.event_name == 'issues' && contains(github.event.issue.body, '@claude'))
runs-on: ubuntu-latest
env:
AWS_REGION: us-west-2
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Generate GitHub App token
id: app-token
uses: actions/create-github-app-token@v2
with:
app-id: ${{ secrets.APP_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}

- name: Configure AWS Credentials (OIDC)
uses: aws-actions/configure-aws-credentials@v4
with:
role-to-assume: ${{ secrets.AWS_ROLE_TO_ASSUME }}
aws-region: us-west-2

- uses: anthropics/claude-code-action@v1
with:
github_token: ${{ steps.app-token.outputs.token }}
use_bedrock: "true"
claude_args: '--model us.anthropic.claude-sonnet-4-6 --max-turns 10'

name: Claude PR Action

permissions:
contents: write
pull-requests: write
issues: write
id-token: write

on:
issue_comment:
types: [created]
pull_request_review_comment:
types: [created]
issues:
types: [opened, assigned]

jobs:
claude-pr:
if: |
(github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude')) ||
(github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude')) ||
(github.event_name == 'issues' && contains(github.event.issue.body, '@claude'))
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Generate GitHub App token
id: app-token
uses: actions/create-github-app-token@v2
with:
app-id: ${{ secrets.APP_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}

- name: Authenticate to Google Cloud
id: auth
uses: google-github-actions/auth@v2
with:
workload_identity_provider: ${{ secrets.GCP_WORKLOAD_IDENTITY_PROVIDER }}
service_account: ${{ secrets.GCP_SERVICE_ACCOUNT }}

- uses: anthropics/claude-code-action@v1
with:
github_token: ${{ steps.app-token.outputs.token }}
trigger_phrase: "@claude"
use_vertex: "true"
claude_args: '--model claude-sonnet-4-5@20250929 --max-turns 10'
env:
ANTHROPIC_VERTEX_PROJECT_ID: ${{ steps.auth.outputs.project_id }}
CLOUD_ML_REGION: us-east5
VERTEX_REGION_CLAUDE_4_5_SONNET: us-east5

故障排除

Claude 不响应 @claude 命令

验证 GitHub 应用是否正确安装，检查工作流是否已启用，确保 API 密钥在仓库密钥中设置，并确认评论包含 @claude（不是 /claude）。

CI 不在 Claude 的提交上运行

确保您使用的是 GitHub 应用或自定义应用（不是 Actions 用户），检查工作流触发器是否包含必要的事件，并验证应用权限是否包括 CI 触发器。

身份验证错误

确认 API 密钥有效且具有足够的权限。对于 Bedrock/Vertex，检查凭证配置并确保密钥在工作流中正确命名。

高级配置

Action 参数

Claude Code Action v1 使用简化的配置：

*提示是可选的 - 当对 issue/PR 评论省略时，Claude 响应触发短语
**对于直接 Claude API 是必需的，对于 Bedrock/Vertex 不是必需的

传递 CLI 参数

claude_args 参数接受任何 Claude Code CLI 参数：

claude_args: "--max-turns 5 --model claude-sonnet-4-6 --mcp-config /path/to/config.json"

常见参数：

• --max-turns：最大对话轮数（默认：10）
• --model：要使用的模型（例如，claude-sonnet-4-6）
• --mcp-config：MCP 配置的路径
• --allowedTools：允许的工具的逗号分隔列表。--allowed-tools 别名也可以使用。
• --debug：启用调试输出

替代集成方法

虽然 /install-github-app 命令是推荐的方法，但您也可以：

• 自定义 GitHub 应用：对于需要品牌用户名或自定义身份验证流的组织。创建您自己的 GitHub 应用，具有所需的权限（contents、issues、pull requests），并使用 actions/create-github-app-token action 在您的工作流中生成令牌。
• 手动 GitHub Actions：直接工作流配置以获得最大灵活性
• MCP 配置：Model Context Protocol 服务器的动态加载

有关身份验证、安全和高级配置的详细指南，请参阅 Claude Code Action 文档。

自定义 Claude 的行为

您可以通过两种方式配置 Claude 的行为：

1. CLAUDE.md：在您的仓库根目录的 CLAUDE.md 文件中定义编码标准、审查标准和项目特定规则。Claude 在创建 PR 和响应请求时将遵循这些指南。查看我们的 Memory 文档了解更多详情。
2. 自定义提示：在工作流文件中使用 prompt 参数提供工作流特定的说明。这允许您为不同的工作流或任务自定义 Claude 的行为。

Claude 在创建 PR 和响应请求时将遵循这些指南。