工程开发
release-prep avatar

release-prep

自动化 MassGen 发布准备流程,包括生成 CHANGELOG 条目、草拟发布公告以及在 git 标记前验证文档完整性。

简介

release-prep 技能是一项专门的自动化工具,旨在简化 MassGen 存储库的软件发布生命周期。它通过将繁琐的手动文档任务整合为单一可靠的指令,协助开发人员和发布经理在 git 标记之前完成准备工作。此技能通过分析 git 历史记录、提交日志与合并请求数据,确保项目文件(包括变更日志、README 和配置文件)在多个平台上的结构一致且保持最新状态。

  • 自动通过解析 git 日志和合并的拉取请求来识别自上次版本标记以来的变更。

  • 按照 Keep a Changelog 格式更新 CHANGELOG.md,明确列出新增功能、修复的错误以及文档更新。

  • 将旧的发布公告存档至 docs/announcements/archive 目录,以维护历史纪录。

  • 同步核心项目文件的文档,包括更新基于 Sphinx 的文件 (index.rst) 中的“近期发布”区块,以及 massgen/configs/README.md 中的发布历史。

  • 重新生成主存储库 README.md 中的“最新功能”区块,确保发布亮点、使用示例和成就总结保持最新。

  • 执行验证检查以确保文档链接、文件路径(如 .rst、.md、.yaml)以及贡献者清单的准确性。

  • 使用时需要提供版本字符串,例如:/release-prep v0.1.34。

  • 此工具最佳执行时机是在将发布 PR 合并至 main 分支之后,但在创建最终 tag 之前。

  • 它提供了关于在 LinkedIn 和 X 上更新社交媒体公告的具体说明,并考虑了字数限制与格式要求。

  • 使用者应确保拥有正确的 git 历史访问权限,以便提取提交摘要与贡献者统计。

  • 通过强化一致的发布说明与文档更新,此技能减少了公开发布沟通中的人为错误,并有助于维持高质量的项目可见度。

仓库统计

Star 数
968
Fork 数
151
Open Issue 数
6
主要语言
Python
默认分支
main
同步状态
空闲
最近同步时间
2026年4月29日 07:09
在 GitHub 查看