npm 包 @rwth-layout/semantic-release-test 使用教程

阅读时长 5 分钟读完

简介

@rwth-layout/semantic-release-test 是一个支持语义化版本控制的自动化版本管理工具包。该工具包基于 git commit messages 来自动管理版本号,并生成 changelog。具备自动化发布到 npm、GitHub 等平台的能力。

安装

在终端输入以下命令进行安装:

配置

在项目根目录下创建 .releaserc.json 配置文件,并按需修改以下配置项:

-- -------------------- ---- -------
-
  ---------- -
    ------------------------------------
    --------------------------------------------
    ------------------------------
    ------------------------
    ------------------------
    --------------------------
  -
-

上述配置中包含以下插件:

  • @semantic-release/commit-analyzer: 分析 git commit message 确定版本号类型。
  • @semantic-release/release-notes-generator: 生成发行说明。
  • @semantic-release/changelog: 生成 CHANGELOG.md。
  • @semantic-release/npm: 发布到 npm。
  • @semantic-release/git: 推送 tag、commit、和 CHANGELOG.md 到 git repo。
  • @semantic-release/github: 发布到 GitHub。

使用示例

commit message

在提交代码时,需要按照以下格式书写 commit message(遵守Angular commit message 规范):

其中,type 取值为以下之一:

Type Description
feat 新增 feature
fix 修复 bug
docs 修改文档
style 格式化代码(不影响代码含义的变化)
refactor 重构代码(既不新增功能,也不修复 bug)
perf 改进性能
test 新增或修改测试
chore 维护代码库(非 src 或 test)
revert 撤销之前的 commit

scope 为可选项,subject、body、footer 分别为必填项。以下为 commit message 示范:

发布

在终端输入以下命令进行发布:

注意:在发布之前需要保证 package.json 中 version 字段为当前版本号。如果版本号尚未发生变更,发布会被跳过。

结语

以上就是 @rwth-layout/semantic-release-test 的使用教程,它能为我们提供自动化版本控制、管理与发布的便利。掌握语义化版本控制加强工具的使用能力,使得我们能够更加快速高效地进行前端开发。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066b6051ab1864dac67273

纠错
反馈