Claude Code Action 使用指南

Claude Code Action 使用指南

claude-code-action 项目地址: https://gitcode.com/gh_mirrors/cl/claude-code-action

1. 项目介绍

Claude Code Action 是一个为 GitHub PRs 和 issues 设计的通用型自动化助手。它能够在检测到特定的触发词（如 @claude）时激活，对代码进行审查、回答代码相关问题、实现代码更改等操作。此项目支持多种认证方式，包括直接使用 Anthropic API、Amazon Bedrock 和 Google Vertex AI 等。

2. 项目快速启动

在您的项目中使用 Claude Code Action 的步骤如下：

首先，确保您是仓库管理员，因为安装 GitHub 应用和添加密钥需要管理员权限。

1. 安装 Claude GitHub 应用到您的仓库：Claude GitHub App
2. 将 ANTHROPIC_API_KEY 添加到您的仓库密钥中。
3. 将以下工作流文件复制到您的仓库的 .github/workflows/ 目录下：

name: Claude Assistant

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

jobs:
  claude-response:
    runs-on: ubuntu-latest
    steps:
    - uses: anthropics/claude-code-action@beta
      with:
        anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
        github_token: ${{ secrets.GITHUB_TOKEN }}

3. 应用案例和最佳实践

以下是一些使用 Claude Code Action 的案例和最佳实践：

• 提问与解答：在 PR 或 issue 中评论 @claude What does this function do?，Claude 将分析代码并给出解释。
• 请求修复：评论 @claude Can you add error handling here?，Claude 将尝试添加错误处理代码。
• 代码审查：评论 @claude Please review this PR，Claude 将提供详细的代码审查意见。
• 自动化文档更新：当 API 相关文件发生变化时，自动更新 README 文档。

4. 典型生态项目

目前，Claude Code Action 支持以下 GitHub 事件：

• pull_request：当 PR 被打开或同步时触发。
• issue_comment：当在 issue 或 PR 上创建评论时触发。
• pull_request_comment：当在 PR 差异上创建评论时触发。
• issues：当 issue 被打开或分配时触发。
• pull_request_review：当 PR 审查被提交时触发。
• pull_request_review_comment：当在 PR 审查上创建评论时触发。

通过整合这些事件，您可以创建一个自动化的代码审查和工作流程，以提高开发效率和代码质量。

claude-code-action 项目地址: https://gitcode.com/gh_mirrors/cl/claude-code-action