SuperAPI AI 工具集

changelog-automation

办公与效率

查看项目

更新于 10-16 05:07

技能介绍

用途:自动化生成变更日志(changelog)、发布说明(release notes)与版本管理,遵循行业标准格式。适用场景包括:搭建自动化 changelog 生成、实施 Conventional Commits、创建发布说明工作流、统一提交信息格式、生成 GitHub/GitLab 发布说明、管理语义化版本。

主要能力与规范:采用 Keep a Changelog 格式,并遵循 Semantic Versioning。文档给出 Keep a Changelog 头部模板,以及按摘要、亮点、破坏性变更、升级指南、已知问题、依赖更新等条目组织的发布说明结构示例(如性能提升、依赖从某版本升级到另一版本的说明)。提供 Conventional Commits 提交信息示例,涵盖带作用域的功能提交、引用 issue 的缺陷修复、破坏性变更标记(! 与 BREAKING CHANGE 页脚)以及多段说明,并在修复中引用 Fixes #456、Reviewed-by 等。

最佳实践:应遵循 Conventional Commits 以便自动化;写清晰信息;引用 issue 关联工单;一致使用作用域;自动化发布以减少人工错误。不应混合变更(每次提交一个逻辑变更);不应跳过校验(使用 commitlint);不应手工编辑(只使用生成的 changelog);不应遗漏破坏性变更(用 ! 或页脚标记);不应忽略 CI(在流水线中校验提交)。

使用方式与限制:更详细的模式与完整示例存放在 references/details.md,当上层导航不足时再阅读该文件。本资料未提供具体安装命令、依赖清单、支持平台或定价信息,这些暂未提供。具体实现须结合自身仓库与 CI 配置,且提交信息与变更条目的准确性依赖团队约定与校验工具。