<a aria-label="Vercel 标志" href="https://vercel.com"> <img src="https://yellow-cdn.veclightyear.com/0a4dffa0/dc90926b-a88a-4179-8454-4d516273d306.svg?style=for-the-badge&logo=vercel&labelColor=000000&logoWidth=20"> </a>

Release

Release 是一个命令行工具，用于自动生成新的 GitHub Release 并填充自上次发布以来的变更（提交）。

使用方法

首先，从 npm 安装软件包：

npm install -g release

或者，你可以使用 Yarn 来安装：

yarn global add release

安装完成后，你可以在项目目录中运行以下命令：

release <type>

可以传递 <type> 参数。如果省略，将从最近的提交和标签创建 GitHub Release。

根据 SemVer 规范，参数可以是以下值之一：

• major：引入了不兼容的 API 更改
• minor：以向后兼容的方式添加了功能
• patch：应用了向后兼容的错误修复

除了这些值外，我们还支持创建预发布版本，如 3.0.0-canary.1：

release pre

你还可以用自定义后缀替换 "canary"，如下所示：

release pre <suffix>

假设你提供 "beta" 作为 <suffix>，你的发布版本将是 3.0.0-beta.1 – 以此类推...

选项

以下命令将显示所有可用选项的列表：

release help

预定义类型

如果你想进一步自动化 release，可以通过在括号中添加到标题或描述中来指定提交的更改类型：

错误日志记录现在可用了 (patch)

假设你为某个提交定义了类型，release 就不会要求你手动设置类型。这将使创建发布的过程更快。

要预定义某个提交应该从列表中排除，可以使用以下关键字：

这是一个提交消息 (ignore)

自定义钩子

有时你可能想通过添加介绍文本、替换某些数据或仅更改变更顺序来过滤插入新版本的信息。

使用自定义钩子，上述示例（以及更多）很容易实现：

默认情况下，release 会在项目的根目录中查找名为 release.js 的文件。该文件应导出一个带有两个参数的函数，并始终返回一个 String（最终发布）：

module.exports = async (markdown, metaData) => {
    // 使用可用数据创建自定义发布
    return markdown;
};

在上面的示例中，markdown 包含发布的 String（如果你只想替换某些内容）。此外，metaData 包含以下属性：

属性名	内容
changeTypes	更改类型及其描述
commits	自上次发布以来的提交列表
groupedCommits	类似于 commits，但按更改类型分组
authors	发布协作者的 GitHub 用户名

提示： 你可以使用 --hook 或 -H 标志指定钩子文件的自定义位置，该标志接受相对于当前工作目录的路径。

为什么？

当我们 Vercel 将所有 GitHub 仓库从维护 HISTORY.md 文件转换为使用 GitHub Releases 时，我们需要一种方法从自己的设备自动生成这些发布，而不是总是需要在浏览器中打开页面并手动为每个更改添加说明。

贡献

你可以在这里找到身份验证流程。

1. Fork 此仓库到你自己的 GitHub 账户，然后 clone 到你的本地设备
2. 如果已安装软件包，请先卸载：npm uninstall -g release
3. 将软件包链接到全局模块目录：npm link
4. 现在你可以在命令行中使用 release 了！

和往常一样，你可以使用 npm test 运行测试，看看你的更改是否破坏了任何东西。

致谢

非常感谢 Daniel Chatfield 在 npm 上捐赠 "release" 这个名称，以及我可爱的团队告诉我他们的需求以及如何使这个软件包尽可能高效。

作者

Leo Lamprecht (@leo)