GoldenDict-NG 项目中的变更日志生成优化实践

在软件开发过程中，变更日志(Changelog)是记录版本间改动的重要文档。GoldenDict-NG 项目目前使用 mikepenz/release-changelog-builder-action 工具来自动生成变更日志，但在实际使用中发现了一些需要改进的问题。

当前实现的问题分析

当前实现主要存在两个关键问题：

1. 合并提交的干扰：工具基于 git diff 命令比较两个提交之间的差异来生成变更日志。当默认合并分支不同时，git diff 会产生不同的结果，导致日志内容不一致。

2. 无关信息混入：生成的变更日志中包含了大量非功能性提交信息，如"merge staged to dev"这类合并操作的提交记录，这些信息对最终用户没有实际价值，反而降低了变更日志的可读性。

解决方案探索

针对上述问题，项目团队提出了几种解决方案：

1. 分支策略调整：通过修改构建流程，直接从 staged 分支触发构建，而不是先合并到 dev 分支再构建。这样可以避免产生"merge staged to dev"这类无意义的合并提交。

2. 日志过滤机制：考虑引入正则表达式过滤机制，从生成的变更日志中剔除无关的合并操作信息，保留真正有意义的特性变更和修复记录。

3. 手动编辑补充：对于不频繁的发布版本，可以接受手动编辑最终的变更说明，这种方式虽然不够自动化，但对于低频发布的项目来说也是可行的方案。

最佳实践建议

基于 GoldenDict-NG 项目的实际情况，建议采用以下组合策略：

1. 日常开发阶段：保持现有的自动化变更日志生成机制，通过调整分支策略减少噪音。

2. 正式发布阶段：在自动化生成的基础上进行人工审核和编辑，确保发布说明的准确性和专业性。

3. 长期规划：考虑迁移到更智能的变更日志生成工具，或者开发自定义脚本，能够更好地识别和分类不同类型的提交。

变更日志作为项目与用户沟通的重要桥梁，其质量直接影响用户对项目进展的理解。通过持续优化生成机制，GoldenDict-NG 项目能够为用户提供更清晰、更有价值的版本变更信息。