SuperAPI AI 工具集

ship

部署与运维

查看项目

更新于 11-06 16:15

技能介绍

用途

Ship 用于把一个已经完成、并且已经通过验证的改动,从当前工作树一路推进到生产环境。它不只停在“提交”或“推送”,而是继续完成合并、观察检查、确认结果真正上线。该技能的前置条件是:这项改动本身的检查已经在 verify 环节完成,Ship 从 verify 之后开始接手。

主要能力与执行步骤

一、检查工作树 运行 git status,阅读每一个被改动的文件。如果发现本次任务中没有改动过的文件,要指出文件名并在提交前询问。把不属于本次任务的文件一起提交属于 ship-flag-stray-files 问题。同时扫描 diff 中的密钥、令牌、密码和 .env 文件;已提交的密钥属于 ship-no-secrets,密钥需要标记出来并入轮换流程,而不是仅仅删掉了事。

二、按变更拆分提交 每次逻辑变更对应一个提交:一个功能、一个修复、一次重命名应分成三个提交,混在一起属于 ship-commit-per-change。提交信息采用 Conventional Commit 格式:type(scope): summary,使用祈使语气、小写、结尾不加句号;类型可用 feat、fix、docs、refactor、chore 等标准类型,破坏性变更在类型后加 !。像“Remove the archive.”这样的写法属于 ship-conventional-commits。对于会发布版本的包,改动要同时附带 changeset;与发布绑定却没有 changeset 的改动属于 ship-changeset-for-packages。

三、推送、合并与清理 推送分支。当被要求合并时,执行合并、删除该分支,并切回默认分支;合并后留下分支属于 ship-merge-and-tidy。每个 bug 或功能对应一个拉取请求,一个 PR 打包三个修复属于 ship-one-pr-per-bug。涉及 UI 的 PR 需在描述中附截图,否则属于 ship-screenshot-ui-prs。

四、观察检查 等待 CI 结束,修复失败项。在 CI 仍在运行或红色时报告“已推送”属于 ship-watch-checks。

五、闭环 如果改动修复了某个 issue,要关联它、关闭它,并在问题提出的地方回复;修复已合并但 issue 仍打开属于 ship-close-the-loop。如果改动需要部署,打开线上 URL 或已发布版本进行检查;只说“已部署”而不看生产环境属于 ship-confirm-live。

六、只把必须由用户做的事交还 凡是能自己执行的步骤都要执行;只有当需要登录、双因素验证码或审批时才询问用户,并明确说明需要哪一项。把一串命令交给用户自己运行属于 ship-do-the-steps。

报告方式

严重程度分级:HIGH 包括提交了密钥、误提交杂散文件、在检查失败时发布;MEDIUM 包括打包提交或打包 PR、修复后 issue 仍未关闭、本可自行执行却交还给用户的步骤;LOW 包括不符合 Conventional Commit 的提交信息、缺少截图、合并后残留分支。

每条发现对应一个根本原因,格式为:有文件时用 file:line - [rule-id] 问题描述,无文件时用 step N - [rule-id] 问题描述。随后给出 Rule | Count | Severity 汇总。存在任何 HIGH 时阻断,否则通过。凡是没有观察到最后的检查,都要标记为 Not verified。

适用场景

适用于需要把功能、修复、文档或重构等改动提交、推送、创建 PR、合并并确认上线的开发流程,尤其是要求提交粒度清晰、提交信息规范、PR 与 issue 对应、部署后核实上线的团队仓库。

限制

该技能依赖 git 与 CI 等现有 Git 工作流,资料未说明支持哪些具体托管平台或 CI 系统。它不负责改动本身的质量验证(由 verify 在此之前完成),也无法替代需要用户凭据、双因素验证码或审批的环节。资料未提供安装方式、命令用法与收费信息。