document-release

其他 已审计 @garrytan v1.0.0
信任分
92/100
兼容 Agent
1
速查档案 只列事实:领域、Agent、信任分、作者、原文章节。装与不装请看下方作者解读。
领域
通用
兼容 Agent
Claude Code
信任分
92 / 100 · 已通过审计
作者 / 版本 / 许可
@garrytan · v1.0.0 · 未声明 license
安装命令数
1 条

需要注意: 未限定 allowed-tools,默认拥有全部工具权限。

想读作者英文原文? ↓ 滚到正文区切换 · 在 GitHub 查看 ↗

解读由编辑根据原文凝练而成,命令、链接、术语均与作者原文一致;想看完整论述请切到右侧

设计思路

document-release 是发布前给仓库文档做体检的 skill:扫一遍 README.md / ARCHITECTURE.md / CONTRIBUTING.md / CHANGELOG.md / TODOS.md / VERSION,挨个判断要不要更新、要不要润色措辞。最关键的纪律——永不静默 bump VERSION永不替换 CHANGELOG:CHANGELOG 只可以润色措辞,不删不重写不重生成。

PR/MR 标题同步

如果 VERSION 文件存在且非空:

  1. V=$(cat VERSION | tr -d '[:space:]')
  2. 拿当前 PR/MR 标题:GitHub 用 gh pr view --json title -q .title、GitLab 用 glab mr view -F json | jq -r .title。空就跳过:No PR/MR found — skipping title sync.
  3. 用共享 helper 算正确标题(和 /ship 同源): NEW_TITLE=$(~/.claude/skills/gstack/bin/gstack-pr-title-rewrite.sh "$V" "$CURRENT_TITLE") helper 处理三种情况:标题已正确(no-op)/ 有不同 v<X.Y.Z.W> 前缀(替换)/ 没版本前缀(追加)。
  4. 如果 NEW_TITLE 与原标题不同:GitHub gh pr edit --title、GitLab glab mr update -t
  5. 编辑命令失败:warn 一句「Could not update PR/MR title — documentation changes are still in the commit.」继续,不阻塞

终输出格式

打一份逐文件的 doc 健康摘要:

Documentation health:
  README.md       [status] ([details])
  ARCHITECTURE.md [status] ([details])
  CONTRIBUTING.md [status] ([details])
  CHANGELOG.md    [status] ([details])
  TODOS.md        [status] ([details])
  VERSION         [status] ([details])

status 取值:Updated(描述改了什么)、Current(不需要改)、Voice polished(措辞润色)、Not bumped(用户选不 bump)、Already bumped(已经被 /ship bump 过)、Skipped(文件不存在)。

重要规则

  • Read before editing——改前先读全文。
  • CHANGELOG 永不 clobber——只润色措辞。
  • VERSION 永不静默 bump——总是问;即使已经 bump 过也要核对范围是否覆盖了所有变化。
  • 每次编辑都给一句 summary——明确改了什么。
  • 通用启发式,不针对项目特化——审计要在任何 repo 上都能跑。
  • Discoverability matters——每个 doc 文件都要能从 README / CLAUDE.md 抵达。
  • Voice: friendly, user-forward, not obscure——像在向「聪明但没看过代码」的人解释。

适合谁

  • 准备发布 release 想把文档过一遍的项目维护者
  • 周期性给开源项目做文档体检的人
  • 团队里负责 release notes 的工程师

何时不该用

  • 早期原型——文档还没成形
  • 私人脚本仓库——单仓不需要这套

配套

ship(发布主流程)、finishing-a-development-branch(开发收尾)、devex-review(DX 维度的更深审计)。