git-changelog

📝 自动生成规范化版本变更日志

基于 Conventional Commits 规范,自动解析 Git 历史生成结构化变更日志,简化版本发布文档编写工作。

收藏
1.4k
安装
470
版本
v1.0.0
CLS 安全性认证2026-05-08
点击查看完整报告 >

使用说明

Git Changelog 是一款专注于自动化生成版本变更日志的文档型 Skill,它通过解析 Git 仓库的提交历史,基于 Conventional Commits 规范自动分类和整理发布说明,帮助开发团队高效完成版本发布文档工作。

核心用法方面,该 Skill 首先自动检测版本范围,通过 git tag 命令识别最新标签,获取自上次发布以来的所有提交记录;若仓库尚无标签,则默认读取最近 50 条提交。随后,它使用 Conventional Commits 规范解析提交信息,自动将 feat: 归类为功能更新、fix: 归类为缺陷修复、BREAKING CHANGE 标记为破坏性变更等,同时支持为非规范提交设置"其他变更"分类。Skill 还能自动识别 GitHub/GitLab 远程仓库地址,为每条提交生成可点击的链接。最终输出符合业界标准的 Markdown 格式变更日志,并支持追加写入 CHANGELOG.md 文件。

显著优点包括:完全基于本地 Git 工具,无需 API 密钥或网络连接;严格遵循 Conventional Commits 行业标准,确保团队协作规范统一;内置完善的边界情况处理机制,如支持 Monorepo 场景下的路径过滤、自定义日期范围查询、无标签仓库的兜底方案等;输出格式专业美观,自带 Emoji 分类标识,提升发布说明的可读性。

潜在缺点在于:高度依赖 Conventional Commits 规范,若团队未采用该提交规范,分类效果将大打折扣;作为纯文档型 Skill,它仅提供操作指南而非直接执行,需要用户手动复制命令运行;来源可信度为 T3 级(个人维护项目),虽经安全审计但仍需用户自行判断内容可靠性;对于复杂的自定义格式需求,提供的模板可能不够灵活。

适合的目标群体主要包括:开源项目维护者、企业版本发布管理员、遵循 DevOps 流程的开发团队、需要定期生成发布说明的产品经理,以及希望规范 Git 工作流程的技术团队。

使用风险极低,该 Skill 仅包含只读的 Git 查询命令(如 git loggit tag),不涉及文件修改、系统命令执行或网络数据传输。主要风险在于 T3 来源的维护稳定性,建议在生产环境使用前进行充分测试。性能方面,对于拥有数万条提交的大型仓库,日志查询可能需要较长时间,建议配合日期范围参数使用。

安全解读

核心用法

Git Changelog 是一个纯文档型 Skill,专注于自动从 Git 提交历史中生成格式化的变更日志和发布说明。它通过解析 Conventional Commits 规范(如 feat:fix:docs: 等前缀)智能分类提交记录,并支持自动生成可点击的提交链接。

典型工作流程
1. 自动检测版本范围(最新 tag 至 HEAD,或最近的 50 次提交)

2. 提取提交元数据(哈希、消息、作者、时间戳)

3. 按标准类别分组:✨ Features、🐛 Bug Fixes、📝 Documentation、♻️ Refactoring、⚡ Performance、✅ Tests、🔧 Chores、💥 Breaking Changes

4. 可选生成 Markdown 格式的提交链接(GitHub/GitLab 兼容)

5. 输出到 CHANGELOG.md 或标准输出

高级特性

  • 支持 Monorepo 场景,可通过路径过滤指定包的变更
  • 自定义日期范围查询
  • 优雅处理边界情况:无标签时回退到计数模式、无 Conventional Commits 时按日期分组、空范围时提示"无变更"

显著优点

  • 零依赖零配置:纯 Markdown 实现,无需 API 密钥、无需安装额外工具
  • 标准兼容:深度集成 Conventional Commits 生态,与主流开源项目工作流无缝衔接
  • 自动化程度高:一键生成专业级发布文档,显著减少手动整理成本
  • 安全可信:S+ 顶级安全评级,无可执行代码,完全透明

潜在局限

  • 依赖本地 Git 仓库状态,需要合理的分支和标签管理
  • 对非 Conventional Commits 的解析能力有限,会归入"Other Changes"
  • Squash merge 场景下可能需要 --first-parent 参数清理历史
  • 不支持自动生成 SemVer 版本号,需手动指定版本标题

适合人群

  • 开源项目维护者需要快速生成 Release Notes
  • 团队希望标准化变更文档但不想引入复杂工具链
  • 个人开发者追求极简工作流,拒绝重量级 changelog 生成器
  • 对安全性有极致要求的场景(如企业内网 CI/CD)

常规风险

风险极低。该 Skill 仅执行本地 git log 查询和文本格式化操作,不写入 Git 历史、不上传敏感信息、不调用外部服务。唯一需注意:若启用自动写入 CHANGELOG.md,请确保文件权限正确以避免意外覆盖。

git-changelog 内容

手动下载zip · 2.1 kB
README.mdtext/markdown
请选择文件