Github actions and code review

🤖 学习笔记：自动化代码审查与 CI (Code Review & CI Automation)

🎯 核心概念：自动化重复性工作

• 目标： 在 Pull Request (PR) 中自动化处理重复性工作（如代码审查）。
• 两种实现方式：
• 托管式 (Managed)： CodeReview
• 自建式 (DIY)： Cloud Code GitHub Action

☁️ 方案一：CodeReview (托管式)

• 定义： Anthropic 托管的服务，通过 Cloud GitHub App 审查 PR。
• 工作流程：
• 自动将审查结果作为行内评论 (inline comments) 发布。
• 无需用户自行构建或托管服务。
• 功能特点：
• 分析代码差异 (diff) 与完整代码库。
• 按严重程度标记发现的问题，并提供摘要表。
• 具备去重和排序功能，减少噪音。
• 限制：
• 不具备决策权： 永远不会批准或阻止 PR，最终判断由人类决定。
• 无自动修复： 修复操作需在本地终端执行 (/code review --fix)。
• 状态： 目前为研究预览版 (Research Preview)，仅限团队和企业计划。

🛠️ 方案二：Cloud Code GitHub Action (自建式/自定义 CI)

• 定义： 用于处理超出简单审查范围的自定义持续集成 (CI) 任务。
• 部署与设置：
• 组织管理员需在 Cloud Code 设置中开启。
• 安装 Cloud GitHub App，并配置监控的仓库和运行触发条件。
• 触发机制 (Triggers)：
• PR 打开时（每次推送）。
• 用户在评论中提及 (@cloud review)。
• 定时任务 (Scheduled Jobs / Cron)。
• 任何 GitHub 事件。
• 配置命令：
• 使用 /install GitHub App 命令（需要仓库管理员权限）来安装 App 并设置 Anthropic API Key 密钥。
• Action 结构与输入：
• Action 名称： anthropic/cloud code action@v1
• 关键输入 (Inputs)：
• anthropic API key (必需)
• GitHub token (默认使用 secrets. githubtoken)
• trigger phrase (触发短语，默认 at cloud)
• prompt (运行指令/提示)
• cloud arguments (传递给 Cloud Code 的 CLI 参数，用于精细调整)
• 应用场景：
• 实现复杂工作流，例如：根据 PR 评论自动实施规范、生成每日汇总报告等。
• 精细调整 (Tuning)：
• 通过 cloud arguments 进行参数调整，例如设置最大轮数 (max turns)、设置权限模式 (permission mode)、启用工具 (allow tools)。

💡 总结对比

| 特性 | CodeReview (托管) | Cloud Code Action (自建) | | :--- | :--- | :--- | | 复杂度 | 低 (即插即用) | 高 (需配置工作流) | | 功能范围 | 仅审查 (Review) | 审查 + 自定义 CI 任务 | | 修复方式 | 本地手动修复 (--fix) | 自动执行自定义脚本 | | 适用场景 | 快速、标准代码质量检查 | 复杂、定制化的自动化流程 |

Takeaways

• 自动化代码审查和 CI 的目标是处理 Pull Request (PR) 中的重复性工作。
• 实现方式分为托管式 CodeReview 和自建式 Cloud Code GitHub Action 两种。
• CodeReview 是托管服务，用于标准代码分析，通过行内评论（inline comments）标记问题，但无最终决策权。
• Cloud Code GitHub Action 允许用户构建复杂的自定义 CI 工作流，可触发条件包括 PR 打开、用户提及或定时任务。
• 选择实现方式取决于需求复杂度：CodeReview 适用于快速、标准检查；GitHub Action 适用于复杂、定制化的自动化流程。