简介
conventional-gitlab-releaser 是一个 Node.js 的命令行工具,用于自动化生成 GitLab 发布日志。它可以根据规范化的 commit message 自动生成变更日志,并使用 GitLab API 自动发布 GitLab Release。
该工具是基于 conventional-changelog 和 semantic-release-gitlab 开发而来,它们都是非常流行的自动化版本发布工具。
安装
安装前请确保已安装了 Node.js 和 GitLab Personal Access Token。
--- ------- -- ----------------------------
使用
配置
在项目的根目录下创建 .releaserc.json
文件,配置 GitLab 相关信息和 conventional-commits 规范。
- ------------ --------------------- ---------------------- ---------- -------------- ------------------------------- ---------------- ----------------------------------- ----------- --------- --------- --------- -
其中,
gitlabUrl
和gitlabApiPathPrefix
是 GitLab API 的地址和前缀。gitlabToken
是 GitLab Personal Access Token。repositoryUrl
是 GitLab 仓库的 URL。branches
是需要自动生成 Release 的分支。preset
是 conventional-commits 规范的预设配置,例如angular
或eslint
。
发布
运行以下命令自动生成 Release 和变更日志:
---------------------------- -- --------
其中,<preset>
是 conventional-commits 规范的预设配置,例如 angular
或 eslint
。
如果需要手动指定版本号,可以使用 --release-as
参数:
---------------------------- -- -------- ------------ -----
示例代码
以下是一个简单的示例,使用 conventional-gitlab-releaser 自动生成 Release 和变更日志:
- ------------ --------------------- ---------------------- ---------- -------------- ------------------------------- ---------------- ----------------------------------- ----------- --------- --------- --------- -
---------------------------- -- ------- ------------ -----
结语
本文介绍了 npm 包 conventional-gitlab-releaser 的安装和使用方法。该工具可以大大简化发布过程,减少人工操作,提高效率。希望本文对你有帮助!
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/49567