关于 changelog-generator
Changelog Generator 是一项将 Git 历史整理为面向用户的结构化变更摘要的技能。它按变更类型归类提交、过滤内部工作,并可遵循项目指定的写作规范。
主要功能
- 01按日期或版本扫描提交
- 02按类别整理变更
- 03将技术改动改写为用户语言
- 04过滤内部提交
- 05遵循更新日志风格规范
- 06生成发布与更新说明
适用场景
- 01为版本准备发布说明
- 02汇总每周或每月更新
- 03撰写应用商店更新描述
- 04制作面向客户或内部的公告
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ shipshitdev/ skills --skill changelog-generator安装后在 Claude Code 中输入/changelog-generator确认已加载。
附带文件plugin.jsonREADME.md
详细介绍
变更日志生成器
适用场景
- 为新版本准备发行说明
- 创建每周或每月的产品更新摘要
- 向客户说明变更
- 为应用商店提交编写变更日志条目
- 生成更新通知
- 创建内部发行文档
- 维护公开的变更日志/产品更新页面
此技能的功能
- 扫描 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
示例
用户:“为过去 7 天内的提交创建一份变更日志”
输出:
# 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
灵感来源: Manik Aggarwal 在 Lenny's Newsletter 中分享的用例
提示
- 在 Git 仓库根目录运行
- 指定日期范围,生成重点明确的变更日志
- 使用你的 CHANGELOG_STYLE.md,确保格式一致
- 发布前检查并调整生成的变更日志
- 将输出直接保存到 CHANGELOG.md
相关用例
- 创建 GitHub 发行说明
- 编写应用商店更新说明
- 为用户生成电子邮件更新
- 创建社交媒体公告帖
评论
支持 Markdown