安装
学习如何在您的仓库中安装和设置 Claude Code Action。
前提条件
在安装 Claude Code Action 之前,请确保您拥有:
- 一个 GitHub 仓库
- 仓库管理员权限
- 访问 Claude Code CLI
- 一个 Anthropic API 密钥或 Claude Code OAuth 令牌
快速安装(推荐)
安装 Claude Code Action 最快的方法是使用 Claude Code CLI:
1. 打开 Claude Code
claude
2. 运行安装命令
/install-github-app
此命令将引导您完成:
- 安装 Claude GitHub 应用
- 设置所需的密钥
- 配置您的工作流文件
手动安装
如果您希望手动设置或需要更多控制:
1. 安装 Claude GitHub 应用
访问 https://github.com/apps/claude 并在您的仓库上安装该应用。
2. 设置身份验证
将以下密钥之一添加到您的仓库:
选项 A:Anthropic API 密钥(推荐)
- 进入您的仓库设置
- 导航到 Secrets and variables → Actions
- 点击 New repository secret
- 名称:
ANTHROPIC_API_KEY - 值:您的 Anthropic API 密钥
选项 B:Claude Code OAuth 令牌
- 进入您的仓库设置
- 导航到 Secrets and variables → Actions
- 点击 New repository secret
- 名称:
CLAUDE_CODE_OAUTH_TOKEN - 值:您的 OAuth 令牌
3. 创建工作流文件
在您的仓库中创建 .github/workflows/claude.yml:
name: Claude Code Action
on:
issues:
types: [opened, labeled]
pull_request:
types: [opened, labeled, synchronize]
issue_comment:
types: [created]
permissions:
contents: write
issues: write
pull-requests: write
jobs:
claude:
runs-on: ubuntu-latest
steps:
- uses: anthropics/claude-code-action@v1
with:
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
# 或使用 OAuth 令牌:
# claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
4. 提交并推送
git add .github/workflows/claude.yml
git commit -m "Add Claude Code Action workflow"
git push
替代身份验证方法
Amazon Bedrock
- uses: anthropics/claude-code-action@v1
with:
aws_access_key_id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws_region: us-east-1
Google Vertex AI
- uses: anthropics/claude-code-action@v1
with:
gcp_project_id: ${{ secrets.GCP_PROJECT_ID }}
gcp_service_account_key: ${{ secrets.GCP_SERVICE_ACCOUNT_KEY }}
gcp_region: us-central1
自定义 GitHub 应用设置(高级)
对于需要自定义 GitHub 应用的组织:
1. 创建 GitHub 应用
- 进入 GitHub 设置 → 开发者设置 → GitHub Apps
- 点击 New GitHub App
- 配置最小权限:
- Contents:读和写
- Issues:读和写
- Pull requests:读和写
2. 生成私钥
- 在您的 GitHub 应用设置中
- 滚动到 Private keys
- 点击 Generate a private key
- 下载并保护
.pem文件
3. 在仓库上安装应用
- 进入您的 GitHub 应用设置
- 点击 Install App
- 选择目标仓库
4. 添加密钥
将这些密钥添加到您的仓库:
APP_ID:您的 GitHub 应用 IDAPP_PRIVATE_KEY:.pem文件的内容
5. 更新工作流
- uses: anthropics/claude-code-action@v1
with:
github_app_id: ${{ secrets.APP_ID }}
github_app_private_key: ${{ secrets.APP_PRIVATE_KEY }}
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
验证
安装后,通过以下方式测试操作:
- 创建一个新问题或拉取请求
- 添加标签
claude(如果使用基于标签的触发器) - 检查 Actions 选项卡以查看工作流运行
安全最佳实践
- 切勿将 API 密钥直接提交到您的仓库
- 为所有敏感值使用 GitHub Actions 密钥
- 定期轮换 API 密钥和令牌
- 避免在工作流输出中记录敏感变量
- 定期审查 GitHub 应用权限
故障排除
操作未触发
- 验证工作流文件位于
.github/workflows/ - 检查是否设置了所需的密钥
- 确保 GitHub 应用已安装在仓库上
- 审查工作流触发条件
身份验证错误
- 确认 API 密钥有效且处于活动状态
- 检查密钥名称是否与工作流配置匹配
- 验证 GitHub 应用具有必要的权限
权限错误
- 确保工作流具有
contents: write权限 - 验证 GitHub 应用具有所需的仓库访问权限
- 检查组织级别的限制