在release-it中实现变更日志文件自动拷贝的技术方案

release-it作为一款流行的版本发布工具，其强大的插件系统和钩子机制为开发者提供了灵活的扩展能力。本文将深入探讨如何利用release-it的钩子机制，在变更日志生成后自动将其拷贝到指定位置的技术实现方案。

问题背景

在实际项目开发中，我们经常需要将生成的变更日志文件(CHANGELOG.md)同步到多个位置。例如，在monorepo项目中，可能需要在根目录和各子包中都保留变更日志。然而，release-it的默认工作流程中，变更日志的生成时机与Git提交操作之间存在一定的时序关系，这使得简单的文件拷贝操作面临挑战。

release-it的工作流程解析

release-it的执行流程主要分为以下几个阶段：

1. 版本号更新阶段
2. 变更日志生成阶段
3. Git操作阶段（包括add和commit）
4. 发布阶段

关键点在于，@release-it/conventional-changelog插件生成变更日志的操作是在版本号更新之后，但在Git添加操作之前完成的。

钩子机制的选择

release-it提供了丰富的钩子点，我们需要选择最合适的时机插入文件拷贝操作：

• after:bump：在版本号更新后触发，但此时变更日志尚未生成
• before:git:release：在Git操作前触发，但此时已经执行了git add
• before:release：在发布前触发，Git操作已完成

经过实践验证，before:release是最适合的钩子点，虽然它发生在git add之后，但我们可以通过再次执行git add来确保拷贝后的文件被纳入版本控制。

实现方案

以下是完整的配置示例：

// .release-it.js
module.exports = {
  hooks: {
    "before:release": [
      "cp CHANGELOG.md destination/CHANGELOG.md", // 拷贝变更日志
      "git add ." // 确保新拷贝的文件被添加到Git
    ]
  },
  plugins: {
    "@release-it/conventional-changelog": {
      preset: "conventionalcommits",
      infile: "CHANGELOG.md",
      header: "# Changelog"
    }
  }
}

注意事项

1. 文件路径处理：在monorepo项目中，需要特别注意文件路径的准确性，确保源文件和目标路径都正确无误。

2. Git操作：由于我们在before:release钩子中修改了文件系统，必须记得执行git add操作，否则这些变更不会被包含在当前发布版本中。

3. 跨平台兼容性：如果项目需要在不同操作系统上运行，建议使用跨平台的文件操作命令或工具。

4. 错误处理：考虑在脚本中添加错误处理逻辑，确保文件拷贝失败时能够及时发现并中断流程。

替代方案探讨

如果对多次执行git add操作有顾虑，也可以考虑以下替代方案：

1. 自定义脚本：编写一个自定义脚本，在release-it执行完毕后处理文件拷贝和Git操作。

2. 构建流程集成：将文件拷贝操作集成到项目的构建流程中，而非依赖release-it的钩子。

3. 符号链接：对于简单的用例，可以考虑使用符号链接而非文件拷贝。

总结

通过合理利用release-it的钩子机制，我们能够灵活地扩展其默认工作流程，实现变更日志文件的自动拷贝功能。虽然需要在Git操作时序上做出一些妥协，但通过再次执行git add可以确保所有变更都被正确纳入版本控制。这一方案特别适合需要在多个位置维护变更日志的复杂项目结构。