npm 包 pivotalchangelog 使用教程

PivotalChangelog 是一个用于生成项目变更日志的 npm 包。它可以根据 git commit 记录生成一份清晰的变更日志，方便开发人员和项目管理人员了解项目的变更情况。

本文将介绍 pivotalchangelog 的安装与使用，让你轻松生成变更日志。

安装

在终端中输入以下命令安装 pivotalchangelog：

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

使用

配置

在项目的跟目录下新建文件 .pivotalchangelogrc.json，并写入以下配置：

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

在这个配置文件中，你需要配置以下属性：

title：变更日志标题；
dateFrom：筛选从哪个时间开始的 commit 记录；
dateTo：筛选到哪个时间为止的 commit 记录；
commitUrl：commit 记录的链接地址，其中 yourusername 和 yourrepository 分别是你的 GitHub 用户名和仓库名；
groups：将 commit 记录根据关键字分组，方便查看变更信息。每个分组需要配置 title 属性和 keywords 属性。

生成变更日志

在终端中输入以下命令生成变更日志：

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

执行完毕后，你将在项目的跟目录下找到一个名为 changelog.md 的文件，里面就是你生成的变更日志。

示例

假设你现在是一名前端开发人员，正在管理一个名为 myproject 的项目。这个项目有如下几个 commit 记录：

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

你可以根据上面的 commit 记录来生成变更日志，假设你想生成从 2020-01-01 到现在的变更日志。你可以设置以下配置文件：

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

然后在终端中输入以下命令：

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

执行完毕后，你将在项目的跟目录下找到一个名为 changelog.md 的文件，里面就是你生成的变更日志。

变更日志示例如下：

myproject 变更日志

新特性

bfc5a14 add login page

修复 Bug

b62e4d2 fix login page style

性能优化

613784d optimize login page loading speed

重构代码

3c22cf7 refactor login page code

文档更新

85904e6 update README.md

代码格式化

8c30712 format login page code

测试用例

a59241d add login page test

构建系统

e263e6f change build script

依赖更新

454b1c7 update dependencies

其他变更

ddd7d4b add code review comments (revert)

注：上面的 commit 记录仅用于示例，实际项目中可能有多个分支，变更日志应该只包含指定时间段内的主分支 commit 记录。

结语

pivotalchangelog 是一款非常实用的 npm 包，可以让你轻松生成变更日志，方便管理项目。本文介绍了 pivotalchangelog 的安装和使用，希望对你有所帮助。

来源：JavaScript中文网，转载请联系管理员！本文地址：https://www.javascriptcn.com/post/6005596781e8991b448d6e97