SuperAPI AI 工具集

pr-review-ci

编程与开发

查看项目

更新于 11-16 16:45

技能介绍

MCode Review 以 GitHub Actions 工作流或 GitLab CI 子流水线的形式运行,两个平台包含相同的作业:prepare 不调用模型,负责准备分级、评审方向、净差异指纹、重复提示和上一轮状态,并决定本轮是否写入测验;review 调用模型,按分级使用的每个评审方向各运行一个作业,先发现问题再核验 P0 与 P1;quiz 调用模型,在 prepare 要求时生成可选的作者测验;publish 不调用模型,输出结论、摘要评论、线程、测验评论与答案记录以及可选的飞书卡片;grade 不调用模型,立即记录测验答案而不等到下次推送。每个作业运行插件里 ci/review.mjs 的一个子命令,插件固定在 MCODE_REVIEW_PLUGIN_REF 指向的 40 位提交上,该提交属于 github.com/MiniMax-AI/mcode-stack。

接入 GitHub 仓库需要启用 GitHub Actions、runner 能访问 github.com、npm registry 和模型端点,并拥有仓库设置的管理员权限。先从固定提交下载工作流到 .github/workflows/mcode-review.yml,并在顶层 env 中把 MCODE_REVIEW_PLUGIN_REF 的占位符替换为该提交,保持 MCODE_REVIEW_TEMPLATE_VERSION、MCODE_REVIEW_PLUGIN_PATH、MCODE_REVIEW_HOST 和各作业不变。随后在 Settings → Secrets and variables → Actions 中设置 secret MCODE_REVIEW_API_KEY、variable MCODE_REVIEW_BASE_URL,以及可选的 MCODE_REVIEW_LANGUAGE、MCODE_REVIEW_PHASE、MCODE_REVIEW_HTTPS_PROXY、MCODE_REVIEW_PLUGIN_ARCHIVE_URL 和可选的机器人令牌 MCODE_REVIEW_GITHUB_TOKEN。grade 依赖评论触发,须等工作流进入默认分支后才开始工作。

接入 GitLab 项目需要能运行 node:22 镜像且能访问 github.com、npm registry 和模型端点的 runner,以及设置 CI/CD 变量和创建项目访问令牌的 Maintainer 角色。先下载子流水线到 .gitlab/mcode-review.gitlab-ci.yml 且不要编辑副本,再把 dispatch 作业粘贴进 .gitlab-ci.yml,设置其 stage、替换插件提交,并保留 trigger:include:local、yaml_variables: true、pipeline_variables: false 和 Draft 规则。然后在 Settings → CI/CD → Variables 中设置 MCODE_REVIEW_API_KEY、MCODE_REVIEW_BASE_URL、MCODE_REVIEW_GITLAB_TOKEN(环境范围 mcode-review)以及可选项。

模板版本由 prepare 校验:若副本的 MCODE_REVIEW_TEMPLATE_VERSION 与插件代码期望的不一致或缺失,prepare 会停止并提示从指定提交重新复制模板;不得手改版本行。升级或回滚时,应在同一个 PR 中同时更新 MCODE_REVIEW_PLUGIN_REF 并从同一提交复制模板,阅读副本差异,确认作业名、变量、权限或 needs 变化对仓库其他 CI 规则和分支保护的影响。

仓库可在根目录提供两个可选文件:.mcode-review.json 规则包按 key 覆盖默认配置,包含 risk_areas、stacks、ui_globs、generated_globs、tier_thresholds 和 quiz 等;.mcode-review.md 记录已知失败模式。CI 从 merge base 读取两者,因此 PR 无法修改正在评审自己的规则。

语言由 MCODE_REVIEW_LANGUAGE 控制,取值为 en(默认)或 zh;也接受 zh-CN、zh-Hans、chinese,其他值回退为 en。它决定机器人发布的摘要、线程、规则问题、测验和飞书卡片的语言,作业日志保持英文。模型默认所有角色使用 MiniMax-M3.1-Flash,经 Anthropic Messages API 访问 MCODE_REVIEW_BASE_URL;ci/config/models.json 配置提供方、模型、各角色的模型链、超时和可选对照实验。

MCODE_REVIEW_PHASE 默认为 shadow,评审只评论、不阻塞流程;开启分支保护或合并请求的线程解决要求后可切换到 enforce。作者测验可在 .mcode-review.json 中开启,默认当产品代码改动达到 120 行或 4 个文件,或触及风险路径时生成多选题评论,答案公开且不阻塞合并。配置飞书应用凭据后,publish 还会把测验作为卡片发送到指定群聊并随作答更新。

安全模型方面,GitHub 工作流顶层设置 permissions: {},各作业按需申请权限;调用模型的 review 与 quiz 只获得模型密钥、不持有 GitHub 令牌,并以 persist-credentials: false 检出代码;来自 fork 的 PR 会被跳过,草稿 PR 在标记就绪前也会跳过。GitLab 的机器人令牌与飞书密钥限定在 mcode-review 环境,仅 prepare、publish、grade 使用该环境且不调用模型。