变更日志生成器
此技能将技术性的 Git 提交记录转换为精美、用户友好的变更日志(Changelog),让客户和用户能够真正理解和欣赏。通过分析提交历史、分类变更,并将技术性提交转化为清晰、面向客户的发布说明,将数小时的手动编写工作缩短为几分钟的自动生成。
何时使用此技能
- 为新版本准备发布说明(Release Notes)
- 创建每周或每月的产品更新摘要
- 为客户记录变更内容
- 编写应用商店提交的变更日志条目
- 生成更新通知
- 创建内部发布文档
- 维护公开的变更日志/产品更新页面
此技能的功能
- 扫描 Git 历史:分析特定时间段或版本之间的提交记录
- 分类变更:将提交按逻辑类别分组(新功能、改进、Bug 修复、破坏性变更、安全更新)
- 技术语言转用户语言:将开发者提交转换为客户能理解的语言
- 专业格式化:创建清晰、结构化的变更日志条目
- 过滤噪音:排除内部提交(重构、测试等)
- 遵循最佳实践:应用变更日志规范和品牌语调
使用方法
基本用法
在项目仓库中:
从上次发布以来的提交创建变更日志
生成过去一周所有提交的变更日志
为版本 2.5.0 创建发布说明
指定日期范围
创建 3 月 1 日到 3 月 15 日之间所有提交的变更日志
使用自定义规范
从 v2.4.0 以来的提交创建变更日志,使用 CHANGELOG_STYLE.md 中的变更日志规范
示例
用户:"创建过去 7 天提交的变更日志"
输出:
# 更新 - 2024 年 3 月 10 日当周
## 新功能
- **团队工作区**:为不同项目创建独立工作区。邀请团队成员,保持一切井然有序。
- **键盘快捷键**:按 ? 查看所有可用快捷键。无需触碰鼠标即可快速导航。
## 改进
- **更快的同步**:文件跨设备同步速度提升 2 倍
- **更好的搜索**:搜索现已包含文件内容,不仅限于标题
## Bug 修复
- 修复大图片无法上传的问题
- 解决定时发布中的时区混乱问题
- 修正通知角标计数错误
灵感来源: Manik Aggarwal 在 Lenny's Newsletter 中的用例
使用技巧
- 在 Git 仓库根目录运行
- 指定日期范围以生成聚焦的变更日志
- 使用 CHANGELOG_STYLE.md 保持格式一致性
- 发布前审查并调整生成的变更日志
- 直接将输出保存到 CHANGELOG.md
相关用例
- 创建 GitHub 发布说明
- 编写应用商店更新描述
- 为用户生成邮件更新
- 创建社交媒体公告帖子