Release-it项目：如何在不修改代码托管平台 Release日志的情况下上传资源文件

在使用Release-it工具管理代码托管平台项目发布时，开发者可能会遇到一个常见需求：需要向已有的代码托管平台 Release中添加资源文件（assets），但又不希望覆盖现有的Release说明文档。本文将详细介绍这一场景下的解决方案。

问题背景

代码托管平台 Release是项目版本发布的重要功能，它允许开发者上传编译后的二进制文件、文档等资源。Release-it作为一款流行的发布工具，提供了自动化创建和更新代码托管平台 Release的功能。然而，当开发者仅需要向现有Release添加资源文件时，默认情况下Release-it会重新生成Release说明，这可能会覆盖已有的精心编写的变更日志。

解决方案

通过Release-it的代码托管平台插件配置，可以实现只上传资源而不修改Release说明的目标。具体方法如下：

1. 使用update模式：通过--github.update参数告诉Release-it更新现有Release而非创建新Release

2. 禁用自动生成说明：结合--github.autoGenerate参数，这会向代码托管平台 API发送body: null和generate_release_notes: true参数

3. 完整命令示例：

npx release-it --ci -VV --no-increment --github.update --github.autoGenerate --github.assets=my-asset.zip

技术原理

这种方案之所以有效，是因为：

1. update模式确保操作针对现有Release
2. autoGenerate参数中的body: null避免了内容覆盖
3. 代码托管平台 API对generate_release_notes参数的处理是：如果Release已有说明，则保持原样

注意事项

1. 此方案属于"hacky"方式，并非官方推荐的最佳实践
2. 建议在CI环境中使用时添加--ci参数确保非交互模式
3. 可以通过-VV参数开启详细日志，便于调试

替代方案

如果上述方法不适用，开发者还可以考虑：

1. 使用代码托管平台 CLI工具直接上传资源
2. 编写自定义脚本调用代码托管平台 API
3. 使用专门的代码托管平台 Actions实现资源上传

总结

Release-it作为功能强大的发布工具，通过合理配置可以满足各种发布场景需求。对于只需上传资源文件的情况，虽然官方文档没有明确说明，但通过组合使用update和autoGenerate参数，开发者可以实现不修改Release说明的前提下添加资源文件的目标。这种方法在维护已有项目的Release历史时尤为有用。