如何在release-it中自定义代码托管平台发布版本名称格式

release-it是一个流行的自动化版本发布工具，它可以帮助开发者自动化执行版本更新、生成变更日志、创建Git标签以及在代码托管平台上发布版本等操作。在使用过程中，许多开发者希望自定义发布版本的名称格式，本文将详细介绍如何实现这一需求。

默认行为与问题描述

默认情况下，release-it在代码托管平台上创建发布版本时，会使用"Release x.x.x"这样的格式作为发布名称，其中x.x.x代表具体的版本号。例如，当发布1.0.0版本时，默认的发布名称会是"Release 1.0.0"。

然而，许多开发团队更倾向于使用"vx.x.x"这样的格式，即版本号前加上字母"v"而不是"Release"这个词。这种格式在语义化版本控制中更为常见，也更容易与Git标签格式保持一致。

解决方案

release-it提供了灵活的配置选项，允许开发者自定义代码托管平台发布版本的名称格式。要实现将"Release x.x.x"改为"vx.x.x"，只需在项目配置文件中进行相应设置。

配置方法

在项目的package.json文件中，找到release-it的配置部分（通常在"release-it"字段下），添加或修改platform.releaseName配置项：

"release-it": {
  "platform": {
    "release": true,
    "releaseName": "v${version}"
  }
}

配置说明

1. platform.release: 设置为true表示启用代码托管平台发布功能
2. platform.releaseName: 定义发布版本的名称格式
   • ${version}是一个占位符，会被实际的版本号替换
   • 在前面加上"v"即可实现"vx.x.x"的格式

高级配置选项

除了简单的"v"前缀外，release-it还支持更复杂的发布名称格式：

1. 包含项目名称:

   "releaseName": "项目名称 v${version}"
   

2. 使用自定义前缀:

   "releaseName": "版本: ${version}"
   

3. 完全自定义格式:

   "releaseName": "${name}@${version} 发布"
   

验证配置

在修改配置后，可以通过以下方式验证效果：

1. 运行release-it --dry-run进行试运行，查看输出中是否显示预期的发布名称
2. 实际运行release-it命令后，在代码托管平台的"Releases"页面检查发布的名称是否符合预期

最佳实践建议

1. 保持一致性：确保发布名称格式与项目的Git标签格式保持一致
2. 团队共识：在团队项目中，应与团队成员讨论并确定统一的命名规范
3. 文档记录：在项目的README或贡献指南中记录发布名称的格式规范

通过以上配置，开发者可以轻松实现release-it发布版本名称的自定义，满足不同项目的需求规范。