Claude Code GitHub Actions

Claude Code GitHub Actions 為您的 GitHub 工作流程帶來 AI 驅動的自動化。只需在任何 PR 或議題中簡單地提及 @claude，Claude 就可以分析您的程式碼、建立拉取請求、實現功能和修復錯誤 - 同時遵循您專案的標準。

Claude Code GitHub Actions 建立在 Claude Code SDK 之上，該 SDK 可將 Claude Code 以程式方式整合到您的應用程式中。您可以使用 SDK 來建立超越 GitHub Actions 的自訂自動化工作流程。

為什麼使用 Claude Code GitHub Actions？

即時 PR 建立：描述您需要什麼，Claude 會建立一個包含所有必要變更的完整 PR
自動化程式碼實現：使用單一命令將議題轉變為可運作的程式碼
遵循您的標準：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 應用程式和必要祕密的設定。

您必須是儲存庫管理員才能安裝 GitHub 應用程式並新增祕密
GitHub 應用程式將要求內容、議題和拉取請求的讀取和寫入權限
此快速入門方法僅適用於直接 Claude API 使用者。如果您使用 AWS Bedrock 或 Google Vertex AI，請參閱使用 AWS Bedrock 和 Google Vertex AI 部分。

手動設定

如果 /install-github-app 命令失敗或您偏好手動設定，請遵循以下手動設定說明：

安裝 Claude GitHub 應用程式到您的儲存庫：https://github.com/apps/claude Claude GitHub 應用程式需要以下儲存庫權限：
- 內容：讀取和寫入（修改儲存庫檔案）
- 議題：讀取和寫入（回應議題）
- 拉取請求：讀取和寫入（建立 PR 和推送變更）
如需有關安全性和權限的更多詳細資訊，請參閱安全性文件。
新增 ANTHROPIC_API_KEY 到您的儲存庫祕密（了解如何在 GitHub Actions 中使用祕密）
複製工作流程檔案從 examples/claude.yml 到您的儲存庫的 .github/workflows/

完成快速入門或手動設定後，透過在議題或 PR 評論中標記 @claude 來測試 action！

從 Beta 升級

Claude Code GitHub Actions v1.0 引入了重大變更，需要更新您的工作流程檔案才能從 beta 版本升級到 v1.0。

如果您目前使用 Claude Code GitHub Actions 的 beta 版本，我們建議您更新工作流程以使用 GA 版本。新版本簡化了配置，同時新增了強大的新功能，例如自動模式偵測。

基本變更

所有 beta 使用者必須對其工作流程檔案進行這些變更才能升級：

更新 action 版本：將 @beta 變更為 @v1
移除模式配置：刪除 mode: "tag" 或 mode: "agent"（現在自動偵測）
更新提示輸入：將 direct_prompt 替換為 prompt
移動 CLI 選項：將 max_turns、model、custom_instructions 等轉換為 claude_args

重大變更參考

舊版 Beta 輸入	新版 v1.0 輸入
`mode`	（已移除 - 自動偵測）
`direct_prompt`	`prompt`
`override_prompt`	`prompt` 搭配 GitHub 變數
`custom_instructions`	`claude_args: --system-prompt`
`max_turns`	`claude_args: --max-turns`
`model`	`claude_args: --model`
`allowed_tools`	`claude_args: --allowedTools`
`disallowed_tools`	`claude_args: --disallowedTools`
`claude_env`	`settings` JSON 格式

前後範例

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-5-20250929"

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: |
      --system-prompt "Follow our coding standards"
      --max-turns 10
      --model claude-sonnet-4-5-20250929

action 現在會根據您的配置自動偵測是否在互動模式（回應 @claude 提及）或自動化模式（使用提示立即執行）中執行。

範例使用案例

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

使用斜線命令

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 }}
          prompt: "/review"
          claude_args: "--max-turns 5"

使用提示的自訂自動化

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 claude-opus-4-1-20250805"

常見使用案例

在議題或 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 對您的專案標準的理解。

安全考量

永遠不要直接將 API 金鑰提交到您的儲存庫！

如需全面的安全指導，包括權限、身份驗證和最佳實踐，請參閱 Claude Code Action 安全性文件。始終為 API 金鑰使用 GitHub 祕密：

將您的 API 金鑰新增為名為 ANTHROPIC_API_KEY 的儲存庫祕密
在工作流程中參考它：anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
將 action 權限限制為僅必要的權限
在合併前檢查 Claude 的建議

始終使用 GitHub 祕密（例如 ${{ secrets.ANTHROPIC_API_KEY }}），而不是直接在工作流程檔案中硬編碼 API 金鑰。

最佳化效能

使用議題範本提供上下文，保持您的 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
斜線命令 - 預先建立的提示，例如 /review 或 /fix
CLI 傳遞 - 透過 claude_args 的任何 Claude Code CLI 引數
靈活的觸發器 - 適用於任何 GitHub 事件

訪問 examples 目錄以取得完整的工作流程檔案。

在回應議題或 PR 評論時，Claude 會自動回應 @claude 提及。對於其他事件，使用 prompt 參數提供指令。

使用 AWS Bedrock 和 Google Vertex AI

對於企業環境，您可以使用 Claude Code GitHub Actions 搭配您自己的雲端基礎設施。此方法讓您可以控制資料駐留和計費，同時保持相同的功能。

先決條件

在使用雲端提供者設定 Claude Code GitHub Actions 之前，您需要：

對於 Google Cloud Vertex AI：

啟用了 Vertex AI 的 Google Cloud 專案
為 GitHub Actions 配置的工作負載身份聯盟
具有必要權限的服務帳戶
GitHub App（建議）或使用預設 GITHUB_TOKEN

對於 AWS Bedrock：

啟用了 Amazon Bedrock 的 AWS 帳戶
在 AWS 中配置的 GitHub OIDC 身份提供者
具有 Bedrock 權限的 IAM 角色
GitHub App（建議）或使用預設 GITHUB_TOKEN

建立自訂 GitHub App（建議用於第三方提供者）

為了在使用 Vertex AI 或 Bedrock 等第三方提供者時獲得最佳控制和安全性，我們建議建立您自己的 GitHub App：

前往 https://github.com/settings/apps/new
填入基本資訊：
- GitHub App 名稱：選擇唯一名稱（例如「YourOrg Claude Assistant」）
- 首頁 URL：您的組織網站或儲存庫 URL
配置應用程式設定：
- Webhooks：取消勾選「Active」（此整合不需要）
設定必要的權限：
- 儲存庫權限：
  - 內容：讀取和寫入
  - 議題：讀取和寫入
  - 拉取請求：讀取和寫入
按一下「建立 GitHub App」
建立後，按一下「產生私密金鑰」並儲存下載的 .pem 檔案
從應用程式設定頁面記下您的 App ID
將應用程式安裝到您的儲存庫：
- 從您的應用程式設定頁面，按一下左側邊欄中的「安裝應用程式」
- 選擇您的帳戶或組織
- 選擇「僅選擇儲存庫」並選擇特定儲存庫
- 按一下「安裝」
將私密金鑰新增為儲存庫祕密：
- 前往您的儲存庫的設定 → 祕密和變數 → Actions
- 建立名為 APP_PRIVATE_KEY 的新祕密，內容為 .pem 檔案的內容
將 App ID 新增為祕密：

建立名為 APP_ID 的新祕密，內容為您的 GitHub App 的 ID

此應用程式將與 actions/create-github-app-token action 一起使用，以在您的工作流程中產生身份驗證令牌。

Claude API 的替代方案或如果您不想設定自己的 Github app：使用官方 Anthropic 應用程式：

從以下位置安裝：https://github.com/apps/claude
無需額外配置身份驗證

配置雲端提供者身份驗證

選擇您的雲端提供者並設定安全身份驗證：

AWS Bedrock

配置 AWS 以允許 GitHub Actions 安全地進行身份驗證，而無需儲存認證。

安全性注意：使用儲存庫特定的配置並僅授予最少必要的權限。

必要設定：

啟用 Amazon Bedrock：
- 請求在 Amazon Bedrock 中存取 Claude 模型
- 對於跨區域模型，請在所有必要區域中請求存取
設定 GitHub OIDC 身份提供者：
- 提供者 URL：https://token.actions.githubusercontent.com
- 受眾：sts.amazonaws.com
為 GitHub Actions 建立 IAM 角色：
- 受信任的實體類型：Web 身份
- 身份提供者：token.actions.githubusercontent.com
- 權限：AmazonBedrockFullAccess 政策
- 為您的特定儲存庫配置信任政策

必要值：設定後，您將需要：

AWS_ROLE_TO_ASSUME：您建立的 IAM 角色的 ARN

OIDC 比使用靜態 AWS 存取金鑰更安全，因為認證是臨時的並自動輪換。

請參閱 AWS 文件以取得詳細的 OIDC 設定說明。

Google Vertex AI

配置 Google Cloud 以允許 GitHub Actions 安全地進行身份驗證，而無需儲存認證。

安全性注意：使用儲存庫特定的配置並僅授予最少必要的權限。

必要設定：

在您的 Google Cloud 專案中啟用 API：
- IAM 認證 API
- 安全令牌服務 (STS) API
- Vertex AI API
建立工作負載身份聯盟資源：
- 建立工作負載身份池
- 新增 GitHub OIDC 提供者，具有：
  - 簽發者：https://token.actions.githubusercontent.com
  - 儲存庫和擁有者的屬性對應
  - 安全性建議：使用儲存庫特定的屬性條件
建立服務帳戶：
- 僅授予 Vertex AI User 角色
- 安全性建議：為每個儲存庫建立專用服務帳戶
配置 IAM 繫結：
- 允許工作負載身份池模擬服務帳戶
- 安全性建議：使用儲存庫特定的主體集

必要值：設定後，您將需要：

GCP_WORKLOAD_IDENTITY_PROVIDER：完整的提供者資源名稱
GCP_SERVICE_ACCOUNT：服務帳戶電子郵件地址

工作負載身份聯盟消除了對可下載服務帳戶金鑰的需求，提高了安全性。

如需詳細的設定說明，請參閱 Google Cloud 工作負載身份聯盟文件。

新增必要的祕密

將以下祕密新增到您的儲存庫（設定 → 祕密和變數 → Actions）：

對於 Claude API（直接）：

對於 API 身份驗證：
- ANTHROPIC_API_KEY：您的 Claude API 金鑰，來自 console.anthropic.com
對於 GitHub App（如果使用您自己的應用程式）：
- APP_ID：您的 GitHub App 的 ID
- APP_PRIVATE_KEY：私密金鑰 (.pem) 內容

對於 Google Cloud Vertex AI

對於 GCP 身份驗證：
- GCP_WORKLOAD_IDENTITY_PROVIDER
- GCP_SERVICE_ACCOUNT
對於 GitHub App（如果使用您自己的應用程式）：
- APP_ID：您的 GitHub App 的 ID
- APP_PRIVATE_KEY：私密金鑰 (.pem) 內容

對於 AWS Bedrock

對於 AWS 身份驗證：
- AWS_ROLE_TO_ASSUME
對於 GitHub App（如果使用您自己的應用程式）：
- APP_ID：您的 GitHub App 的 ID
- APP_PRIVATE_KEY：私密金鑰 (.pem) 內容

建立工作流程檔案

建立與您的雲端提供者整合的 GitHub Actions 工作流程檔案。以下範例顯示 AWS Bedrock 和 Google Vertex AI 的完整配置：

AWS Bedrock 工作流程

先決條件：

啟用了 AWS Bedrock 存取且具有 Claude 模型權限
在 AWS 中配置為 OIDC 身份提供者的 GitHub
具有 Bedrock 權限且信任 GitHub Actions 的 IAM 角色

必要的 GitHub 祕密：

祕密名稱	描述
`AWS_ROLE_TO_ASSUME`	Bedrock 存取的 IAM 角色的 ARN
`APP_ID`	您的 GitHub App ID（來自應用程式設定）
`APP_PRIVATE_KEY`	您為 GitHub App 產生的私密金鑰

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-5-20250929-v1:0 --max-turns 10'

Bedrock 的模型 ID 格式包括區域前綴（例如 us.anthropic.claude...）和版本後綴。

Google Vertex AI 工作流程

先決條件：

在您的 GCP 專案中啟用了 Vertex AI API
為 GitHub 配置的工作負載身份聯盟
具有 Vertex AI 權限的服務帳戶

必要的 GitHub 祕密：

祕密名稱	描述
`GCP_WORKLOAD_IDENTITY_PROVIDER`	工作負載身份提供者資源名稱
`GCP_SERVICE_ACCOUNT`	具有 Vertex AI 存取權限的服務帳戶電子郵件
`APP_ID`	您的 GitHub App ID（來自應用程式設定）
`APP_PRIVATE_KEY`	您為 GitHub App 產生的私密金鑰

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@20250514 --max-turns 10'
        env:
          ANTHROPIC_VERTEX_PROJECT_ID: ${{ steps.auth.outputs.project_id }}
          CLOUD_ML_REGION: us-east5
          VERTEX_REGION_CLAUDE_3_7_SONNET: us-east5

專案 ID 會自動從 Google Cloud 身份驗證步驟中擷取，因此您無需硬編碼它。

疑難排解

Claude 不回應 @claude 命令

驗證 GitHub App 是否正確安裝，檢查工作流程是否已啟用，確保 API 金鑰已在儲存庫祕密中設定，並確認評論包含 @claude（不是 /claude）。

CI 不在 Claude 的提交上執行

確保您使用的是 GitHub App 或自訂應用程式（不是 Actions 使用者），檢查工作流程觸發器是否包含必要的事件，並驗證應用程式權限是否包括 CI 觸發器。

身份驗證錯誤

確認 API 金鑰有效且具有足夠的權限。對於 Bedrock/Vertex，檢查認證配置並確保祕密在工作流程中正確命名。

進階配置

Action 參數

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

參數	描述	必要
`prompt`	Claude 的指令（文字或斜線命令）	否*
`claude_args`	傳遞給 Claude Code 的 CLI 引數	否
`anthropic_api_key`	Claude API 金鑰	是**
`github_token`	用於 API 存取的 GitHub 令牌	否
`trigger_phrase`	自訂觸發短語（預設：「@claude」）	否
`use_bedrock`	使用 AWS Bedrock 而不是 Claude API	否
`use_vertex`	使用 Google Vertex AI 而不是 Claude API	否

*提示是可選的 - 當省略議題/PR 評論時，Claude 回應觸發短語
**對於直接 Claude API 為必要，對於 Bedrock/Vertex 則不是

使用 claude_args

claude_args 參數接受任何 Claude Code CLI 引數：

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

常見引數：

--max-turns：最大對話輪數（預設：10）
--model：要使用的模型（例如 claude-sonnet-4-5-20250929）
--mcp-config：MCP 配置的路徑
--allowed-tools：允許的工具的逗號分隔清單
--debug：啟用偵錯輸出

替代整合方法

雖然 /install-github-app 命令是建議的方法，但您也可以：

自訂 GitHub App：對於需要品牌使用者名稱或自訂身份驗證流程的組織。建立您自己的 GitHub App，具有必要的權限（內容、議題、拉取請求），並使用 actions/create-github-app-token action 在您的工作流程中產生令牌。
手動 GitHub Actions：直接工作流程配置以獲得最大靈活性
MCP 配置：動態載入模型上下文協議伺服器

請參閱 Claude Code Action 文件以取得有關身份驗證、安全性和進階配置的詳細指南。

自訂 Claude 的行為

您可以透過兩種方式自訂 Claude 的行為：

CLAUDE.md：在儲存庫根目錄的 CLAUDE.md 檔案中定義程式碼標準、審查標準和專案特定規則。Claude 在建立 PR 和回應請求時將遵循這些指南。查看我們的 Memory 文件以取得更多詳細資訊。
自訂提示：在工作流程檔案中使用 prompt 參數提供工作流程特定的指令。這允許您為不同的工作流程或任務自訂 Claude 的行為。

Claude 在建立 PR 和回應請求時將遵循這些指南。

開始使用

使用 Claude Code 建構

Claude Agent SDK

部署

管理

設定

參考資料

資源

​為什麼使用 Claude Code GitHub Actions？

​Claude 可以做什麼？

​Claude Code Action

​設定

​快速設定

​手動設定

​從 Beta 升級

​基本變更

​重大變更參考

​前後範例

​範例使用案例

​基本工作流程

​使用斜線命令

​使用提示的自訂自動化

​常見使用案例

​最佳實踐

​CLAUDE.md 配置

​安全考量

​最佳化效能

​CI 成本

​配置範例

​使用 AWS Bedrock 和 Google Vertex AI

​先決條件

​對於 Google Cloud Vertex AI：

​對於 AWS Bedrock：

​對於 Claude API（直接）：

​對於 Google Cloud Vertex AI

​對於 AWS Bedrock

​疑難排解

​Claude 不回應 @claude 命令

​CI 不在 Claude 的提交上執行

​身份驗證錯誤

​進階配置

​Action 參數

​使用 claude_args

​替代整合方法

​自訂 Claude 的行為

為什麼使用 Claude Code GitHub Actions？

Claude 可以做什麼？

Claude Code Action

設定

快速設定

手動設定

從 Beta 升級

基本變更

重大變更參考

前後範例

範例使用案例

基本工作流程

使用斜線命令

使用提示的自訂自動化

常見使用案例

最佳實踐

CLAUDE.md 配置

安全考量

最佳化效能

CI 成本

配置範例

使用 AWS Bedrock 和 Google Vertex AI

先決條件

對於 Google Cloud Vertex AI：

對於 AWS Bedrock：

對於 Claude API（直接）：

對於 Google Cloud Vertex AI

對於 AWS Bedrock

疑難排解

Claude 不回應 @claude 命令

CI 不在 Claude 的提交上執行

身份驗證錯誤

進階配置

Action 參數

使用 claude_args

替代整合方法

自訂 Claude 的行為