| name | changelog-generator |
| description | 通过分析提交历史、分类更改并将技术性提交转换为清晰、客户友好的发布说明,自动从 git 提交创建面向用户的变更日志。将数小时的手动变更日志编写转化为几分钟的自动生成。 |
Changelog Generator
此技能将技术性 git 提交转换为精心制作的、用户友好的变更日志,让你的客户和用户能够真正理解并感激。
何时使用此技能
- 为新版本准备发布说明
- 创建每周或每月产品更新摘要
- 为客户记录更改
- 为应用商店提交编写变更日志条目
- 生成更新通知
- 创建内部发布文档
- 维护公共变更日志/产品更新页面
此技能的功能
- 扫描 Git 历史:分析特定时间段或版本之间的提交
- 分类更改:将提交分组到逻辑类别(功能、改进、错误修复、破坏性更改、安全)
- 技术 → 用户友好转换:将开发人员提交转换为客户语言
- 专业格式化:创建清晰、结构化的变更日志条目
- 过滤噪音:排除内部提交(重构、测试等)
- 遵循最佳实践:应用变更日志指南和你的品牌语调
如何使用
基本用法
从你的项目仓库:
自上次发布以来创建提交的变更日志
为过去一周的所有提交生成变更日志
为版本 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 发布说明
- 编写应用商店更新描述
- 为用户生成邮件更新
- 创建社交媒体公告帖子