解决release-it项目中预发布版本变更日志重复标题问题

在软件开发过程中，版本管理和变更日志记录是至关重要的环节。release-it作为一个流行的版本发布工具，配合其插件conventional-changelog可以自动生成符合规范的变更日志。然而，在使用预发布功能时，开发者可能会遇到变更日志生成不符合预期的情况。

问题现象分析

当使用release-it进行预发布版本管理时，变更日志生成会出现以下两种不同情况：

1. 预发布分支（如develop分支）使用--preRelease=beta参数时，生成的变更日志格式符合预期
2. 默认分支（如main分支）使用--git.tagExclude='*[-]*'参数时，变更日志会出现重复的版本标题

具体表现为，在默认分支生成的变更日志中，同一个版本的变更会被重复记录，且带有预发布版本的标题前缀，这显然不符合大多数项目的需求。

问题根源探究

经过深入分析，这个问题实际上源于conventional-changelog-writer的工作机制。该组件负责最终生成变更日志的Markdown格式，默认情况下会为每个版本（包括预发布版本）生成独立的标题部分。

当从预发布分支合并到默认分支时，如果没有适当的配置，conventional-changelog-writer会保留预发布版本的标题结构，导致日志中出现重复的版本标题。

解决方案实现

通过深入研究release-it和conventional-changelog的配置选项，我们找到了几种可行的解决方案：

方案一：动态配置writerOpts

利用process.argv判断当前是否为默认分支发布，动态调整writerOpts配置：

const isDefaultBranch = process.argv.includes("--git.tagExclude=*[-]*");

const writerOpts = {};

if (isDefaultBranch) {
  writerOpts.generateOn = undefined;
}

这种方法通过检测命令行参数来判断发布环境，在默认分支发布时禁用特定版本的日志生成。

方案二：条件式生成控制

更精细地控制生成逻辑，只在特定条件下生成变更日志：

writerOpts: {
  generateOn: (...data) => {
    if (process.argv.includes("--git.tagExclude=*beta*")) {
      return;
    }
    return data;
  },
}

这种方法提供了更大的灵活性，可以根据具体需求定制生成条件。

最佳实践建议

基于实际项目经验，我们建议：

1. 在项目配置中明确定义不同分支的发布策略
2. 为预发布和正式发布设置不同的变更日志生成规则
3. 定期检查生成的变更日志是否符合预期
4. 考虑将配置封装为可复用的模块，便于多项目统一管理

通过合理配置release-it和conventional-changelog插件，开发者可以确保变更日志既能准确反映预发布版本的变更，又能在正式版本中保持简洁清晰的格式。这种配置方式特别适合采用Git Flow等分支策略的中大型项目。