关于 changelog-generator
changelog-generator 是一项将 Git 提交整理为面向用户的更新日志的技能。它通过归类变更、过滤内部提交并遵循指定风格,协助团队准备版本说明和产品更新。
主要功能
- 01按版本或日期范围扫描提交
- 02按类别归纳变更
- 03将技术变更改写为用户语言
- 04过滤内部提交
- 05遵循更新日志风格指南
适用场景
- 01准备新版本说明
- 02汇总每周或每月产品更新
- 03撰写应用商店更新描述
- 04维护公开更新日志
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ composio-community/ awesome-claude-plugins --skill changelog-generator安装后在 Claude Code 中输入/changelog-generator确认已加载。
详细介绍
更新日志生成器
这项技能可将技术性 Git 提交转化为精炼、易懂的更新日志,让客户和用户真正看得懂、愿意读。
适用场景
- 为新版本准备发布说明
- 编写每周或每月的产品更新摘要
- 向客户说明变更内容
- 为应用商店提交编写更新日志条目
- 生成更新通知
- 创建内部发布文档
- 维护公开的更新日志/产品更新页面
功能
- 扫描 Git 历史记录:分析特定时间段内或不同版本之间的提交
- 对变更分类:将提交归入逻辑类别(新功能、改进、错误修复、重大变更、安全性)
- 将技术内容转化为用户友好的表述:把开发者提交信息改写成面向客户的语言
- 专业排版:生成简洁、结构清晰的更新日志条目
- 过滤噪声:排除内部提交(重构、测试等)
- 遵循最佳实践:采用更新日志编写指南和你的品牌语调
使用方法
基本用法
在项目仓库中:
Create a changelog from commits since last release
Generate changelog for all commits from the past week
Create release notes for version 2.5.0
指定日期范围
Create a changelog for all commits between March 1 and March 15
使用自定义指南
Create a changelog for commits since v2.4.0, using my changelog
guidelines from CHANGELOG_STYLE.md
输出示例
# 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
提示
- 在 Git 仓库根目录运行
- 指定日期范围,以生成重点更明确的更新日志
- 使用你的 CHANGELOG_STYLE.md,确保格式一致
- 发布前请检查并调整生成的更新日志
- 直接将输出保存到 CHANGELOG.md
相关用途
- 编写 GitHub 发布说明
- 撰写应用商店更新描述
- 生成面向用户的电子邮件更新
- 创建社交媒体公告
评论
支持 Markdown