用途
Ship 的目标是让一次代码变更以干净、小巧、易于回滚的方式落地,并且不夹带任何额外内容。它把「检查改动 → 验证 → 记录变更 → 提交 → 推送 → 汇报」串成一条可重复执行的流程,适合在智能体或人工完成一项改动后作为收尾步骤使用。
主要能力与步骤
1. 查看改动了什么
运行 git status、git diff --stat 以及 git log origin/<branch>..HEAD,把文件分为两类:
- 本次任务:你或用户为这项工作修改的文件。
- 非本次任务:工作区中其他来源的改动(另一个智能体、另一个会话、用户未完成的工作)。不要暂存这些文件,并向用户列出。
永远不要暂存 .env*、密钥、大型二进制文件或构建产物。
2. 检查
查找项目自带的命令(package.json scripts、Makefile、justfile、CI 配置),运行其中较快的检查:类型检查、lint、与改动区域相关的单元测试。执行耗时的完整构建前先询问用户。
确认每项检查确实运行了:阅读输出,而不只看退出码。命令未找到、或测试运行器发现零个测试,都不算通过。检查失败时,修复它,或者停止并报告。不要交付红色状态。
3. Changelog(仅产品变更)
只有当产品用户会感知到该变更时才更新 changelog 或发布说明:新功能、定价或账户变更、重新设计、修复用户报告的 bug。内容类改动(博客文章、文档文案)、重构和内部工具不写入公开 changelog。拿不准时就不写。
4. 提交
按名称暂存路径:git add path/a path/b,不要用 git add -A。
提交信息:一行简短的祈使句,约 60 个字符以内(例如 "Add retry to payment webhook")。仅当原因不明显时才添加正文。若仓库已有约定,遵循它(查看 git log)。
5. 推送
除非用户已经明确要求推送,否则推送前先询问。推送到默认分支前,检查该推送是否会触发部署或中断正在运行的任务(CI 配置、部署钩子)。若推送被拒绝,用 rebase 拉取,重新运行检查,然后再推送。绝不对共享分支执行 force-push。
6. 汇报
报告提交哈希、交付了什么、哪些文件未暂存及原因,以及运行了哪些检查。
使用方式
按上述顺序逐步执行,每一步都以实际命令输出为依据,不跳过检查,不扩大暂存范围。推送与慢速构建等动作需先获得用户同意。
适用场景
- 智能体或开发者完成一项改动后,需要安全收尾并提交。
- 工作区存在多方改动,需要只提交本次任务相关文件。
- 希望在推送前确认不会触发意外的部署或中断任务。
限制
资料未说明该技能的安装方式、依赖环境、支持的平台或收费信息,暂未提供。流程中的具体命令依赖项目自身配置,需按各仓库实际情况执行。