用途
release-notes-composer 用于把技术性的 Git 提交转化为结构清晰、面向用户的更新日志和发行说明。它面向需要对外发布版本信息的开发者与团队,帮助整理版本历史、功能描述和破坏性变更等内容。
主要能力
根据资料,该技能具备以下能力:
- 扫描 Git 历史:分析特定时间段或版本之间的提交记录。
- 归类变更:将提交按逻辑类别分组,包括功能、改进、缺陷修复、破坏性变更和安全。
- 技术语言转用户语言:把开发者提交转换为面向客户表达。
- 专业排版:生成干净、结构化的更新日志条目。
- 过滤噪声:排除重构、测试等内部提交。
- 遵循最佳实践:应用更新日志编写规范与品牌语气。
使用方式
资料给出的基本用法示例包括:
- 从项目仓库创建自上次发布以来的更新日志
- 生成过去一周所有提交的更新日志
- 为版本 2.5.0 创建发行说明
也可指定日期范围或自定义规范,例如:
- 创建 3 月 1 日至 3 月 15 日所有提交的更新日志
- 创建自 v2.4.0 以来的提交更新日志,并使用 CHANGELOG_STYLE.md 中的更新日志规范
输出示例
用户请求“创建过去 7 天提交的更新日志”时,示例输出包含按“新功能”“改进”“修复”等分组的结构化条目,每条以加粗标题加简短说明呈现。
适用场景
资料列出的使用场景包括:
- 为新版本准备发行说明
- 创建每周或每月产品更新摘要
- 为客户记录变更
- 为应用商店提交编写更新日志条目
- 生成更新通知
- 创建内部发行文档
- 维护公开的更新日志或产品更新页面
相关资料还提到可用于创建 GitHub 发行说明、编写应用商店更新描述、生成面向用户的邮件更新以及创建社交媒体公告。
使用提示
资料中的提示包括:从 Git 仓库根目录运行;指定日期范围以生成聚焦的更新日志;使用 CHANGELOG_STYLE.md 保持格式一致;发布前审阅并调整生成的更新日志;可将输出直接保存到 CHANGELOG.md。
限制
资料未提供关于收费、价格、平台支持范围、运行环境依赖、权限要求或具体效果保证的信息,这些内容暂未提供。