npm 包:conventional-changelog-custom-angular-pom 使用教程

阅读时长 4 分钟读完

1. 什么是 conventional-changelog-custom-angular-pom?

conventional-changelog-custom-angular-pom 是一个基于 Angular commit message 格式的插件,可以通过解析 git commit,自动生成符合规范的 changelog。其中,Angular commit message 格式是一种通用的 commit message 格式,它的设计目的是可以让开发者更好地维护代码库。

2. conventional-changelog-custom-angular-pom 的安装与使用

2.1 安装

conventional-changelog-custom-angular-pom 是一个 npm 包,可以通过以下命令进行安装:

2.2 配置

在 Git 仓库的根目录中创建一个名为 .conventional-changelog 的文件,该文件的内容可以参考以下示例:

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

需要注意的是,你需要将其中的 hostownerrepository 替换成自己仓库的地址信息。

2.3 生成 changelog

在终端中执行以下命令,即可生成一个 Markdown 格式的 changelog:

其中,-p 参数表示使用 Angular commit message 格式作为解析模板,-i 参数表示输出文件名,-s 参数表示同步生成 changelog。

3. 示例代码

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

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

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

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

4. 总结

conventional-changelog-custom-angular-pom 插件可以帮助开发者更好地维护代码库,生成规范的 changelog,为项目管理提供便利。欢迎广大前端工程师使用和参考!

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

纠错
反馈