@artale/pi-changelog
基于Git提交历史自动生成项目更新日志
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:@artale/pi-changelog。 它的用途是:基于Git提交历史自动生成项目更新日志 详细介绍见:https://321skill.com/skills/artale-pi-changelog/ 请根据该页面的说明完成安装。
使用示例
'在当前项目目录下生成最新版本的更新日志',它会调用pi-changelog读取本地Git提交历史,自动分类变更内容后输出规范的Markdown格式日志。
对AI说:'帮我生成v1.0.0到v1.1.0版本区间的变更日志',它会指定Git提交范围执行命令,快速输出对应区间的结构化变更记录。
介绍
项目迭代过程中,手动整理更新日志需要逐条梳理Git提交记录,不仅耗时费力,还容易出现变更遗漏、格式混乱、记录与实际改动不符等问题,在版本发布节点往往占用开发人员额外的精力。
作为一款轻量npm工具,它可直接读取本地项目的Git提交历史,自动识别提交内容的类型,将新功能、问题修复、性能优化等变更分类整理,快速生成结构清晰的更新日志,无需人工逐条核对提交记录。
适合有定期版本发布需求的前后端开发人员、开源项目维护者,以及需要统一版本交付文档规范的中小研发团队,尤其适配迭代频率较高、提交记录较多的项目。
若团队提前统一Git提交信息的语义规范,可大幅提升生成日志的分类准确率与可读性,生成后建议对重点变更做少量补充说明,确保对外发布的日志信息清晰易懂。
核心特点
它直接读取本地Git历史生成日志,无需对接远程仓库API或配置Webhook,轻量易接入。
注意事项
仅基于本地Git提交历史生成内容,无法自动关联远程仓库的Issue、PR等关联信息。
常见问题
不统一Git提交规范可以使用吗?
可以,能直接基于现有提交记录生成基础日志。
支持生成指定版本区间的日志吗?
支持,可指定版本范围生成对应区间的变更日志。