介绍
grunt-conventional-github-releaser 是一个npm的包, 用于自动生成标准化的github release日志 ,并将 release 信息推送到 GitHub。这个工具基于 angular 格式(约定式提交)编写的,它遵循这些提交格式,自动生成 release 前的change log,并将其包含在公告中。
安装
在项目根目录通过 npm 安装 grunt-conventional-github-releaser,执行以下命令:
npm install grunt-conventional-github-releaser --save-dev
使用
配置
配置 gruntfile.js 文件:
-- -------------------- ---- ------- ------------------ --------------------------- - -------- - -------- - ----- - ----- -------- ------ -------------------- -- -------------- - ------- --------- - - - - ---展开代码
执行命令
执行以下命令:
grunt conventionalGithubReleaser
具体使用过程中,需要传入 GH_TOKEN 环境变量, 例如:
GH_TOKEN=abcdef0123456789 grunt conventionalGithubReleaser
这样就会自动从 Github 获取仓库相关的信息并向仓库发布一个版本。
示例
下面介绍一个具体的示例,假如我们的仓库已经有一个版本v0.0.1,现在我们需要发布一个 v0.0.2 版本。我们首先在 Github 的仓库设置页生成出一个个人访问令牌,然后在命令行中执行以下命令:
export GH_TOKEN={YOUR_GITHUB_TOKEN} grunt conventionalGithubReleaser
注意,以上命令中{YOUR_GITHUB_TOKEN}需要替换成自己的 Github 访问令牌。
运行完以上命令后,grunt-conventional-github-releaser 会读取当前仓库的 commit 提交历史,自动生成 release 日志,并将其作为提交内容推到 Github 仓库中。
结论
通过本文的介绍,我们了解了如何使用 grunt-conventional-github-releaser 工具,它能够自动化生成 release change log,方便开发者发布软件版本。如果你有相关的需求,我们推荐你尝试该工具,它将为你提供方便快捷的版本发布管理。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/40332