mcpField
P
preflight

preflight

github.com/unlearndev云与 DevOps10583 次安装3 周前更新
代码仓库

关于 preflight

preflight 是一项用于当前分支的生产上线前检查技能,面向准备合并代码的开发者。它通过检查相对基分支的差异,按类型和置信程度整理有文件依据的行动清单。

主要功能

  1. 01检查当前分支相对 main 的差异
  2. 02识别上线所需操作
  3. 03按类型和置信度分组
  4. 04为每项注明相关文件
  5. 05仅列出差异支持的事项

适用场景

  1. 01合并前核对数据库迁移和配置变更
  2. 02确认队列工作进程或外部服务的上线准备
  3. 03整理生产环境需要验证或监控的事项

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/unlearndev/skills --skill preflight

安装后在 Claude Code 中输入/preflight确认已加载。

详细介绍

发布前检查

为当前分支生成一份生产环境发布前检查清单。

步骤

  1. 获取与基准分支的差异:git diff main...HEAD。
  2. 阅读每个变更代码块。检查合并后在生产环境中需要采取的操作,例如:
    • 新增的环境变量/配置键
    • 新增或变更的数据库迁移
    • 推送到队列的任务(需要运行工作进程)
    • 新增的外部服务、邮件、存储或凭据
  3. 根据这些事项列出检查清单。主要按类型分组,类型类别可灵活定义,选择适合这些变更的标签。常见类别包括(不限于此):
    • 数据库——迁移、架构、种子数据。
    • 基础设施——队列工作进程、调度器、必须运行的服务。
    • 配置——环境变量、配置键、凭据。
    • 运维——需要在生产环境中确认或监控的事项。
  4. 在每种类型中,按置信度对子组进行分组。选择合适的置信度标签,例如必需(缺少时会导致故障)、核实/可能需要(几乎肯定需要,取决于设置)、建议/最好确认(值得检查一眼,可能已经处理)。
  5. 每项都引用差异中表明需要该项的文件(不要写行号)。

规则

  • 仅包含差异实际支持的事项。不要猜测或凑数。
  • 若某种类型或置信度分组没有事项,则省略。
  • 按需要采取行动的紧迫程度排列类型,最紧急的放在前面。
  • 每种类型都使用正式标题:名称单独占一行,其下直接加上由框线字符破折号(────)组成的下划线,长度与名称一致。置信度标签保留为普通子标题。
  • 保持输出简短:类型标题、置信度子标题、每项一行。不要写开场白或总结。

评论

支持 Markdown