变更日志生成器
changelog-generator
技能简介
通过分析提交历史、对更改进行分类并将技术提交转化为清晰的客户友好型发布说明,从 git 提交自动生成面向用户的更新日志。将数小时的手动编写工作缩短为几分钟的自动化生成。
技能详情 (README)
name: changelog-generator
version: 1.0.0
description: Automatically creates user-facing changelogs from git commits by analyzing commit history, categorizing changes, and transforming technical commits into clear, customer-friendly release notes. Turns hours of manual changelog writing into minutes of automated generation.
description_zh: 自动从 git 提交记录创建用户友好的更新日志。通过分析提交历史、分类变更,将技术性提交转换为清晰易懂的发布说明。将数小时的手动编写工作缩短为几分钟的自动化生成。
category: docs-writing
recommended: true
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
2. Categorizes Changes: Groups commits into logical categories (features, improvements, bug fixes, breaking changes, security)
3. Translates Technical → User-Friendly: Converts developer commits into customer language
4. Formats Professionally: Creates clean, structured changelog entries
5. Filters Noise: Excludes internal commits (refactoring, tests, etc.)
6. Follows Best Practices: Applies changelog guidelines and your brand voice
How to Use
Basic Usage
From your project repository:
Create a changelog from commits since last releaseGenerate changelog for all commits from the past weekCreate release notes for version 2.5.0With Specific Date Range
Create a changelog for all commits between March 1 and March 15With Custom Guidelines
Create a changelog for commits since v2.4.0, using my changelog
guidelines from CHANGELOG_STYLE.mdExample
User: "Create a changelog for commits from the past 7 days"
Output:
# Updates - Week of March 10, 2024✨ New Features
- Team Workspaces: Create separate workspaces for different
projects. Invite team members and keep everything organized.- Keyboard Shortcuts: Press ? to see all available shortcuts.
Navigate faster without touching your mouse.🔧 Improvements
- Faster Sync: Files now sync 2x faster across devices
- Better Search: Search now includes file contents, not just titles
🐛 Fixes
- Fixed issue where large images wouldn't upload
- Resolved timezone confusion in scheduled posts
- Corrected notification badge count
Inspired by: Manik Aggarwal's use case from Lenny's NewsletterTips
- 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