加载中

GitHub Actions 与代码审查

第 7 课6 分钟
加载中

GitHub Actions 与代码审查

移交重复性工作的最佳场所就是拉取请求(pull request)。这里是审查发生的地方,是变更落地的地方,也是您大量琐碎工作所在的地方。在这里让 Claude 工作有两种方式,它们解决的是不同的问题。一种是您开启的托管服务。另一种是您自己搭建的 GitHub Action。让我们逐一过一遍,弄清楚何时该用哪一种。

托管路径:Code Review

最简单的选项是 Code Review。这是一项由 Anthropic 托管的服务,它通过 Claude GitHub 应用审查您的拉取请求。您无需构建或托管任何东西。只需开启它,它就会开始在关键的代码行上以行内评论的形式发布审查结果。

您 Claude 组织的 Owner 可以在 Claude Code 管理员设置中启用它。您会找到一个"代码审查"(Code review)部分,其中有一个"允许代码审查"(Allow code review)开关,用来启动设置流程。

之后,Owner 安装 Claude GitHub 应用,选择它要监视的仓库,并决定它何时运行。如果该 Owner 本身不是 GitHub 组织的所有者,则必须先由某位所有者安装并链接该应用。关于运行时机,您有几种选择:

  • 在 PR 打开时运行一次
  • 在 PR 的每次推送时运行
  • 仅在有人评论 @claude review 时运行

一旦开启,一切都运行在 Anthropic 的基础设施上。一组审查智能体会对照您完整的代码库来分析差异,而不是孤立地只看改动的那几行。然后,它会在具体的代码行上以行内评论的形式发布审查结果,按严重程度打上标签,并在检查运行(check run)中附上一张汇总表。

每个审查结果都会作为一条来自 Claude 的评论出现在对应的代码行上,附带清晰的解释和建议的修复方案。

这样做的好处是它会对结果去重并排序。因此,您看到的不是一堆琐碎的挑剔意见,而是少数几个真正值得您关注的问题。

Code Review 会做什么,不会做什么

这里有几点关于边界的说明值得记住:

  • 它从不批准或阻止 PR。决策权始终掌握在人类手中。Claude 会标记问题;由您来做决定。
  • 它不会推送修复。该服务只发布审查结果。
  • 它适用于 Team 和 Enterprise 方案。

由于该服务只发布审查结果,接下来要不要处理就得靠您:修复代码并推送。要在推送之前检查您的修复,请在您自己的终端中运行 /code-review。它会对您的差异进行一次独立的审查,其 --fix 标志可以将该审查结果应用到您的工作树中。

DIY 路径:GitHub Action

Code Review 负责审查。当任务超出审查范畴时,您就要用到 GitHub Action 了。这适用于自定义 CI:实现来自某条评论的变更、运行定时报告,以及任何您通常会为其编写工作流的事情。它可以让智能体在 PR 评论、定时任务以及任何 GitHub 事件上运行。

设置从 Claude Code 内部开始。运行 /install-github-app 命令。您需要拥有仓库管理员权限才能执行此操作。该斜杠命令会引导您完成 GitHub 应用的安装,以及在仓库上设置 Anthropic API 密钥的密钥(secret)配置。

该 Action 本身是 anthropics/claude-code-action@v1。以下是您实际会用到的输入参数:

  • anthropic_api_key —— 在运行需要调用 Claude API 时为必需项,除非您使用 claude_code_oauth_token(来自某个 Claude 订阅)或通过工作负载身份联合(workload identity federation,通过 Claude Console 服务账户设置,因此无需存储密钥)进行身份验证。下方的云服务商方式不使用它。
  • github_token —— 可选。不传入此项时,该 Action 会以您在设置时安装的 Claude GitHub 应用身份进行身份验证。只有在需要覆盖该行为时才传入令牌。
  • trigger_phrase —— Action 在评论中监听的触发词。默认值为 @claude。
  • use_bedrock / use_vertex / use_foundry —— 将运行路由到 Amazon Bedrock、Google Cloud's Agent Platform 或 Microsoft Foundry,而不是 Claude API,并使用您的云账户登录,而不是 API 密钥。
  • prompt —— 自动化运行的指令。设置它之后,Claude 会在事件发生时运行,而无需等待被提及。不设置它时,该 Action 会等待触发词。
  • claude_args —— 一个直接传递给 Claude Code 的 CLI 参数字符串。

响应 @claude 的工作流

将一个工作流放入 .github/workflows/claude.yaml,它就会监听 PR 评论和 issue 评论中的 @claude。下面是完整的文件。id-token: write 权限使该 Action 能够以 Claude GitHub 应用身份登录:

yaml
name: Claude Code
on:
  issue_comment:
    types: [created]
  pull_request_review_comment:
    types: [created]
jobs:
  claude:
    if: contains(github.event.comment.body, '@claude')
    runs-on: ubuntu-latest
    permissions:
      contents: write
      pull-requests: write
      issues: write
      id-token: write
      actions: read
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 1
      - uses: anthropics/claude-code-action@v1
        with:
          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
          claude_args: "--max-turns 5 --model claude-sonnet-5"

现在,有人在拉取请求上写下 @claude implement the spec in the linked Linear issue,该 Action 就会接手处理。Claude 会推送提交,并发布描述其所做工作的评论。

按计划运行的工作流

同一个 Action 也适用于每日汇总报告。一个 cron 触发器在比如 UTC 9:00 触发,该 Action 运行您的 prompt,而您可以在这次运行的日志中读取汇总结果。定时运行本身不会自动发布评论。您还可以添加一个 workflow_dispatch 触发器,以便从 Actions 标签页手动触发它:

yaml
name: Daily report
on:
  schedule:
    - cron: "0 9 * * *"
  workflow_dispatch:
jobs:
  report:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      issues: read
      id-token: write
    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: |
            --allowedTools "mcp__github__list_commits,mcp__github__list_issues"

当该 Action 运行时,您可以像查看任何其他 GitHub 工作流一样,在 Actions 标签页中观察它逐步执行的过程。

用 claude_args 调优运行

claude_args 这一行是进行微调的地方。有几个值得了解的旋钮:

  • --max-turns 5 给智能体循环设置了一个硬性上限,使其不会无限运行下去。
  • 权限模式。对于无人值守的任务,您会希望它不要停下来询问,因为没有人在场回答。
  • 允许的工具。只给任务恰好需要的东西,不多不少。对于一份报告来说,这意味着只读权限。

该用哪一种?

简而言之:

  • 对于 PR 审查,走托管路径。启用 Code Review,让 GitHub 应用发布行内审查结果,然后修复代码并推送。
  • 当任务超出审查范畴时,使用该 Action。用 /install-github-app 完成设置,一个工作流用于 @claude 提及,另一个用于 cron 定时任务,所有的调优都在 claude_args 中完成。

从托管服务开始。当您需要 Claude 在 CI 中真正动手做点什么,而不仅仅是发表评论时,再转向使用 Action。