npm 包 ionic-cz-conventional-changelog 使用教程

阅读时长 5 分钟读完

前言

在前端开发过程中,版本控制是一个非常重要的环节。而版本控制中的 changelog,是记录项目版本变更信息的一个创建工具,通过 changelog 可以清晰的了解项目版本的变更信息,而且可以快速的回溯版本。ionic-cz-conventional-changelog 是一个基于 Angular 规范的 changelog 自动化生成工具,支持生成符合 Angular 规范的 changelog,更加规范化、规范起来更加简单。本文将详细介绍 ionic-cz-conventional-changelog 的使用方法。

ionic-cz-conventional-changelog 的安装

通过 npm 命令进行安装:

ionic-cz-conventional-changelog 的使用

安装完成之后,在项目的根目录中执行以下命令即可生成 changelog:

运行命令后,ionic-cz-conventional-changelog 将会通过 Command Line Interface(CLI)的形式,引导你填写 commit message,根据你的输入自动生成符合 Angular 规范的 changelog 文件。

填写 commit message

当我们运行 npm run cz 命令时,ionic-cz-conventional-changelog 会通过命令行界面引导我们输入 commit message,以下是一个例子:

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

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

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

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

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

根据提示,我们依次填写每一项即可,其中包括:

  • 操作类型
  • 操作描述
  • 操作详情
  • 是否有破坏性改动
  • 是否关闭了某个问题

这些信息填写完成后,ionic-cz-conventional-changelog 将会自动将这个信息整理成 changelog,并输出到指定目录的 CHANGELOG.md 文件中。

生成的 changelog 格式

生成的 changelog 文件需要满足 Angular 规范,具体格式如下:

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

--- --------

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

--- --- -----

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

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

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

输出的 changelog 文件,按照版本号递减顺序排列,每个版本都会显示该版本的新增特性以及修复的 bug。如果某个版本有破坏性改动,还会在最上方显示。同时,该工具生成的 changelog 还方便于其他人能够快速的查看到该版本的变更情况,而且格式跟简单易懂。

总结

通过 ionic-cz-conventional-changelog 工具的使用,可以让我们更加规范的记录项目版本变更信息,使得项目的 changelog 变得更加简单易懂。这对于项目后期维护及版本回溯很有帮助,同时,也可以让我们的团队更加注重代码的质量和规范性。

示例代码

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

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

纠错
反馈