Lotus项目自动化生成GitHub Release日志的技术实践

背景与问题

在开源项目Lotus的版本发布过程中，GitHub Release页面是向用户展示版本变更的重要窗口。传统上，这个页面的变更日志需要维护人员手动运行脚本并复制粘贴输出内容，这种人工操作既耗时又容易出错。随着项目规模扩大和发布频率提高，这种手动方式已经成为发布流程中的瓶颈。

技术现状分析

Lotus项目目前使用一个名为mkreleaselog的脚本来生成变更日志。该脚本能够：

1. 计算依赖项的旧版本和新版本
2. 生成从指定版本到最新提交的变更日志
3. 按代码仓库分组显示变更内容
4. 统计贡献者及其提交情况

然而，当前输出存在几个技术问题需要解决：

• 包含了合并提交(merge commit)等非实质性变更
• 缺乏对提交类型的分类(如fix/feat/chore等)
• 格式与人工维护的CHANGELOG.md不一致
• 与PR级别的变更描述可能存在重复

解决方案探讨

方案一：优化现有脚本

对现有mkreleaselog脚本进行增强：

1. 增加提交类型过滤功能，去除合并提交
2. 按照约定式提交(Conventional Commits)规范对变更分类
3. 改进输出格式，使其更接近人工维护的风格
4. 与PR级别的变更描述进行去重处理

方案二：引入专业工具

考虑采用更成熟的变更日志生成工具，如changelog-maker等。这类工具通常具有：

• 更智能的提交信息解析
• 更好的格式控制
• 对线性提交历史的优化处理
• 与现有工作流的集成能力

方案三：混合式方案

结合自动生成与人工审核：

1. 工具生成初步变更日志
2. 维护人员进行内容确认和格式调整
3. 最终发布经过人工优化的版本

技术实现建议

基于Lotus项目的实际情况，推荐采用渐进式改进策略：

1. 基础自动化：首先实现基本的自动化发布流程，确保每次发布都能自动包含变更日志
2. 内容过滤：增加对合并提交的过滤，只保留实质性变更
3. 分类展示：按照fix/feat/chore等类型对变更分组展示
4. 格式统一：使自动生成的格式与CHANGELOG.md保持一致
5. 贡献者统计：保留并优化贡献者统计信息

未来优化方向

随着项目发展，可考虑以下进阶优化：

1. 与PR模板集成，确保变更描述的一致性
2. 实现变更重要性分级
3. 增加对重大变更的突出显示
4. 支持多版本变更对比
5. 集成到CI/CD流水线中实现全自动化

总结

自动化GitHub Release日志生成是提升Lotus项目发布效率和质量的重要一步。通过合理的技术选型和渐进式改进，可以在保持变更日志质量的同时，显著减少维护人员的工作负担。这一改进不仅关乎技术实现，更是项目成熟度的重要体现。