← 中文资源

简体中文版本

发布时间通告起草工作流

起草区分用户影响与内部细节的发布通告,并链接到变更日志。

阅读英文原文

目标

发布需要以准确、不夸大内容的方式清晰传达给用户与相关方。本工作流区分用户可感知的变更与内部细节、按主题分组,直白说明破坏性变更及所需操作与期限,由评审者对照变更日志核实每条声明,最后发布通告并链接到日志与文档。

步骤要点

  1. 区分用户影响与内部细节并分组。
  2. 直白说明破坏性变更及操作与期限。
  3. 由评审者对照日志核实声明。
  4. 发布通告并链接日志与文档。
# keep the announcement claim traceable to the changelog entry
 grep -n 'deprecat' CHANGELOG.md

验证

按顺序执行上述步骤后,逐项确认每个步骤的预期状态均已满足;只有全部预期状态成立,才认为本流程完成。若某一步未达到预期状态,应先按排错提示排查,不要跳过继续,以免掩盖问题。

排错提示

  • 夸大的内部变更会让用户困惑。
  • 埋没破坏性变更会引发支持高峰。
  • 未经核实的声明损害信任。

适用边界

  • 需要变更日志与评审者。
  • 需指定发布渠道。