工程开发
massgen-release-documenter avatar

massgen-release-documenter

自动化并管理 MassGen 发布文档的生命周期,确保符合发布清单、变更日志维护及自动同步流程。

简介

massgen-release-documenter 是一项专为简化 MassGen 框架技术发布流程而设计的专业代理技能。它为开发人员提供了一套结构化且具权威性的工作流程,确保每次软件发布都附有完整、高质量的文档。通过标准化发布路径,该技能最大限度地减少了在更新变更日志 (CHANGELOG)、基于 Sphinx 的技术文档、配置参考及路线图文件等复杂编排过程中可能出现的人为错误。

此技能适用于在 MassGen 存储库中工作的软件工程师与维护者。它在开发周期的最后阶段特别实用,当时确保各个项目构件(包括 README、同步至 PyPI 的文档以及详细案例研究)之间的一致性,对于用户采用与生态透明度至关重要。该代理强制执行严格的依赖顺序,以确保代码的上游变更能够精确地反映在下游的文档输出中。

  • 根据权威文档 docs/dev_notes/release_checklist.md 编排多阶段发布工作流程。

  • 促进 CHANGELOG.md、Sphinx 源文件及配置文件的系统化生成与更新。

  • 整合预提交 (pre-commit) 钩子,以自动化同步 README.md 与 README_PYPI.md 文件。

  • 支持项目案例研究的建立与模板化,协助记录复杂的代理工作流程与模型整合。

  • 为 Sphinx 文档构建、链接检查及路线图状态更新提供明确的验证步骤。

  • 管理特定版本的发布公告转换,包括通过整合工具支持社交媒体内容生成。

  • 始终以更新 CHANGELOG.md 并参考权威的 release_checklist.md 作为启动发布流程的开端。

  • 当 YAML 架构或模型支持发生演变时,利用此技能验证 config_builder.py 和 capabilities.py 中的后端变更是否已记录。

  • 确保所有构件皆通过工具提供的 make html 与 make linkcheck 指令进行验证。

  • 利用自动化优先的策略来降低项目维护与技术写作中的手动开销。

  • 请注意,此技能需要持续访问存储库根目录与文档目录,以执行文件系统操作与验证检查。

仓库统计

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