Changelog Generator
This skill transforms technical git commits into polished, user-friendly changelogs that your customers and users will actually understand and appreciate.
When to Use This Skill
- - Preparing release notes for a new version
- Creating weekly or monthly product update summaries
- Documenting changes for customers
- Writing changelog entries for app store submissions
- Generating update notifications
- Creating internal release documentation
- Maintaining a public changelog/product updates page
What This Skill Does
- 1. Scans Git History: Analyzes commits from a specific time period or between versions
- Categorizes Changes: Groups commits into logical categories (features, improvements, bug fixes, breaking changes, security)
- Translates Technical → User-Friendly: Converts developer commits into customer language
- Formats Professionally: Creates clean, structured changelog entries
- Filters Noise: Excludes internal commits (refactoring, tests, etc.)
- Follows Best Practices: Applies changelog guidelines and your brand voice
How to Use
Basic Usage
From your project repository:
CODEBLOCK0
CODEBLOCK1
CODEBLOCK2
With Specific Date Range
CODEBLOCK3
With Custom Guidelines
CODEBLOCK4
Example
User: "Create a changelog for commits from the past 7 days"
Output:
CODEBLOCK5
Inspired by: Manik Aggarwal's use case from Lenny's Newsletter
Tips
- - Run from your git repository root
- Specify date ranges for focused changelogs
- Use your CHANGELOG_STYLE.md for consistent formatting
- Review and adjust the generated changelog before publishing
- Save output directly to CHANGELOG.md
Related Use Cases
- - Creating GitHub release notes
- Writing app store update descriptions
- Generating email updates for users
- Creating social media announcement posts
更新日志生成器
本技能可将技术性Git提交记录转化为精炼、用户友好的更新日志,让您的客户和用户真正理解并欣赏这些内容。
适用场景
- - 为新版本准备发布说明
- 创建每周或每月产品更新摘要
- 记录面向客户的变更内容
- 编写应用商店提交所需的更新日志条目
- 生成更新通知
- 创建内部发布文档
- 维护公开的更新日志/产品更新页面
功能说明
- 1. 扫描Git历史:分析特定时间段或版本间的提交记录
- 分类变更:将提交内容归入逻辑类别(功能、改进、错误修复、重大变更、安全更新)
- 技术转译:将开发者提交内容转化为客户语言
- 专业排版:创建清晰、结构化的更新日志条目
- 过滤噪音:排除内部提交(重构、测试等)
- 遵循最佳实践:应用更新日志规范及品牌语调
使用方法
基础用法
在项目仓库中:
根据上次发布以来的提交记录创建更新日志
生成过去一周所有提交的更新日志
为版本2.5.0创建发布说明
指定日期范围
创建3月1日至3月15日期间所有提交的更新日志
自定义规范
根据CHANGELOG_STYLE.md中的更新日志规范,为v2.4.0以来的提交创建更新日志
示例
用户:为过去7天的提交创建更新日志
输出:
markdown
更新 - 2024年3月10日当周
✨ 新功能
- - 团队工作区:为不同项目创建独立工作区。邀请团队成员,保持一切井井有条。
- - 键盘快捷键:按?查看所有可用快捷键。无需鼠标即可快速导航。
🔧 改进
- - 更快的同步:文件跨设备同步速度提升2倍
- 更好的搜索:搜索范围现包含文件内容,而不仅是标题
🐛 修复
- - 修复了大图片无法上传的问题
- 解决了定时发布中的时区混乱问题
- 修正了通知徽章计数
灵感来源: Manik Aggarwal在Lennys Newsletter中的用例
提示
- - 在Git仓库根目录运行
- 指定日期范围以生成聚焦的更新日志
- 使用CHANGELOG_STYLE.md保持格式一致
- 发布前检查并调整生成的更新日志
- 将输出直接保存至CHANGELOG.md
相关用例
- - 创建GitHub发布说明
- 编写应用商店更新描述
- 生成面向用户的邮件更新
- 创建社交媒体公告帖子