SuperAPI AI 工具集

mergify-config

通用与其它

查看项目

更新于 10-16 00:29

技能介绍

用途:mergify config 命令组用于校验 Mergify 配置文件是否符合官方 schema,并用本地配置模拟 Mergify 在某个拉取请求上的行为,便于在提交前测试配置改动。

主要能力:validate 校验配置文件;simulate 针对指定 PR 模拟 Mergify 将执行的动作。CLI 会按顺序自动探测配置文件:.mergify.yml/.yaml、.mergify/config.yml/.yaml、.github/mergify.yml/.yaml,同一位置 .yml 优先;存在多个配置文件时会在 stderr 给出警告。可用 --config-file / -f 覆盖。

用法:mergify config validate;mergify config -f .mergify.yml validate;mergify config simulate https://github.com/owner/repo/pull/123。simulate 需提供 PR 完整 URL,可选 --token/-t(环境变量 MERGIFY_TOKEN,回退到 mergify auth login 凭据及 GITHUB_TOKEN/gh auth token,后两者对 Mergify API 已弃用)、--api-url/-u(环境变量 MERGIFY_API_URL,默认 https://api.mergify.com)。校验通过退出码 0,失败打印错误数量及每条错误的路径与信息并退出码 1。

编写配置时应先获取相关文档页面,不要依赖记忆。可先取 https://docs.mergify.com/llms.txt 获取文档索引,再按需获取文件格式、条件语法、数据类型、动作、合并队列与合并保护等页面。

适用场景:本地测试配置改动、CI 校验门禁(如 pip install mergify-cli 后运行 mergify config validate)。

限制:simulate 需要有效凭据与真实 PR;文档内容会随时间变化,需以官方页面为准。