简介
github-release-from-changelog 是一个基于 Node.js 的命令行工具，它可以通过解析 CHANGELOG.md 文件自动生成 Github Release，并且支持同时发布到多个仓库。
该工具对于开发者而言非常实用，因为它能够帮助你自动化发布 Release，减少手动操作的时间和错误率。
安装
使用 npm 安装 github-release-from-changelog：
npm install -g github-release-from-changelog
用法
配置
首先，需要在你的项目根目录下创建 release.config.js 文件，内容如下：
module.exports = {
token: 'YOUR_GITHUB_TOKEN',
changelogPath: './CHANGELOG.md',
owner: 'your-github-username',
repo: 'your-github-repo-name',
tagPrefix: 'v'
}其中：
token：Github Personal Token，需要有repo、write:packages权限。changelogPath：CHANGELOG.md文件的相对路径。owner：Github 仓库所属用户或组织。repo：Github 仓库名称。tagPrefix：Release 标签前缀，例如v。
发布 Release
在终端中输入以下命令来发布 Release：
gh-release-from-changelog release
运行命令后，会自动将解析 CHANGELOG.md 文件生成 Release，并且将其发布到 Github 仓库中。
如果你需要同时发布到多个仓库，可以在 release.config.js 文件中添加以下配置：
-- -------------------- ---- -------
-------------- - -
-- -------
------ - -- ------
-
------ ---------
----- -------
--
-
------ ---------
----- -------
-
-
-然后，在终端中输入以下命令来发布到所有仓库：
gh-release-from-changelog release -a
预览 Release
如果你想要预览 Release 的内容，可以使用以下命令：
gh-release-from-changelog preview
这会在本地启动一个服务器，并自动打开浏览器。你可以在浏览器中查看 Release 的内容，并且可以修改 Release 标题和描述。当你保存修改后，工具会自动将新的标签提交到 Github。
示例代码
假设你的项目名为 my-project，Github 用户名为 my-github-username，仓库名为 my-repo，Release 版本号为 v1.0.0。以下是示例代码：
-- -------------------- ---- ------- - --------- --- ------- ------- -- ---- ------- ---- -- ---------- -- ---- ----- -- -------- - ---------- --- ----- - ------- - - ------- - --- ------- - ------ - --- ----- - --- -
// release.config.js
module.exports = {
token: 'YOUR_GITHUB_TOKEN',
changelogPath: './CHANGELOG.md',
owner: 'my-github-username',
repo: 'my-repo',
tagPrefix: 'v'
}# 发布 Release gh-release-from-changelog release # 预览 Release gh-release-from-changelog preview
总结
github-release-from-changelog 是一个实用的工具，可以帮助开发者自动化发布 Github Release。使用该工具能够提高效率，减少错误率，而且还能支持同时发布到多个仓库。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/39756