无需登录 数据私有 本地保存

CHANGELOG 生成器 - 基于约定式提交自动编写变更日志

61
0
0
0
完整操作步骤
第一步:获取 Git 提交记录

在项目根目录下打开终端,执行 git log --oneline 命令获取提交记录列表。该命令会以单行格式输出所有提交信息,每行包含提交哈希和提交描述。您也可以使用 git log --oneline -20 仅获取最近 20 条提交记录,或使用其他参数筛选特定范围的提交。

第二步:粘贴提交记录到输入框

复制终端中的提交记录输出,粘贴到工具的「提交记录」文本区域中。工具支持 git log --oneline 的标准输出格式,也支持手动整理的提交记录列表。确保每条提交记录占据独立的一行。

第三步:配置版本信息

在配置选项区域填写版本号(如 1.2.0)和发布日期(如 2024-01-15)。版本号建议遵循语义化版本规范(MAJOR.MINOR.PATCH),发布日期格式可自由选择。项目名称为可选项,如果填写则会显示在生成的变更日志标题中。

第四步:选择输出格式

根据项目需求选择输出格式:Keep a Changelog 适用于遵循该规范的项目,简洁格式适合快速发布说明,详细格式则保留更多提交上下文。同时可选择是否使用 Emoji 标记来增强视觉效果。

第五步:生成并导出变更日志

点击「生成 CHANGELOG」按钮,工具会自动解析提交记录并生成格式化的变更日志内容。在结果预览区域查看生成效果,确认无误后点击「复制」将内容复制到剪贴板,或点击「下载 .md」保存为 CHANGELOG.md 文件。

实用技巧
快速体验:如果您想先了解工具效果,可以点击「加载示例」按钮,工具会自动填充示例提交记录,让您无需准备真实数据即可体验完整的生成流程。

在实际使用中,建议按照以下方式优化您的工作流程:首先确保团队成员遵循约定式提交规范编写提交信息,这样生成的变更日志质量最高。其次,定期生成变更日志而不是在发布前一次性整理,可以减少遗漏。最后,将生成的变更日志与版本发布流程结合,在 CI/CD 中集成自动化生成工具(如 standard-version 或 semantic-release),实现完全自动化的版本管理。

如果您发现生成的变更日志中某些分类为空(例如没有 performance 类型的提交),这属于正常现象,说明当前版本中没有该类型的变更。您可以根据需要手动编辑生成的内容,添加额外的说明或注释。