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