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