npm 包 release-it-lerna-changelog 使用教程

阅读时长 3 分钟读完

简介

release-it-lerna-changelog 是一个开源的 npm 包,用于自动化管理多个 package 的版本发布和 CHANGELOG 的生成,并配合 lerna 使用。本文将会介绍如何使用它来简化前端团队迭代过程中不可避免的版本发布和 CHANGELOG 管理流程。

安装

在项目根目录下安装 release-it-lerna-changelog:

配置

在 package.json 中添加 release-it-lerna-changelog 的配置:

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

其中 packageName 是你要生成 CHANGELOG 的 package 名称,labels 是你在提交 commit 时使用的 label,用于自动分组。

发布版本

在使用 git 提交代码之后,只需要运行一条命令即可完成版本发布和 CHANGELOG 生成:

此时 release-it-lerna-changelog 会自动为 package 升级版本、生成 CHANGELOG、提交代码并打 tag,完成版本发布。同时,它还会为你自动生成一个版本提交的 PR,供你进行 review。

示例代码

下面是一个示例代码,用于演示如何在 lerna 项目中使用 release-it-lerna-changelog:

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

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

结语

利用 release-it-lerna-changelog,前端团队可以轻松自动化版本发布和 CHANGELOG 生成,极大地提高了开发效率。希望本文对你有所帮助,也欢迎大家对本文提出宝贵意见和建议。

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

纠错
反馈