前言
在前端项目开发过程中，随着项目不断的推进和迭代，会产生大量的代码变动，因此统一维护项目的 changelog 尤为重要。在这个过程中，我们可以使用 git-changelog-zentao 工具来生成 changelog 并自动更新 zentao。
什么是 git-changelog-zentao？
git-changelog-zentao 是一款能够自动根据 git commit 记录生成项目 changelog 并同步到禅道系统的 npm 包。
安装
在开始之前，确保已经安装了 git 和 node 环境。
npm install -g git-changelog-zentao
使用
基本使用
使用命令行进入到项目的根目录，并使用以下命令生成 changelog：
git-changelog-zentao --config-path ./
此操作会在项目的根目录下生成一个名为 CHANGELOG.md 的文件。
高级用法
如果需要对生成的 changelog 文件进行定制，可以修改相关的配置项。
例如，我们可以通过以下步骤来选择性地生成指定时间段内的 changelog。
- 首先在项目的根目录下添加一个 changelog.config.js 文件，内容如下所示：
module.exports = {
"out": "CHANGELOG.md",
"subtitle": "自动生成的 changelog",
"version": true,
"includedMerges": "false",
"between": ["DAYS", 7]
}- 然后再次运行 git-changelog-zentao 命令即可：
git-changelog-zentao --config-path ./
配置项
在 changelog.config.js 文件中，可以配置以下选项：
- out [string]: 要生成的 CHANGELOG 文件的名称。
- subtitle [string]: CHANGELOG 的副标题。
- version [boolean]: 是否在标题中显示版本号。
- includedMerges [boolean]: 是否包含合并的 commit。
- between [array]: 生成指定时间段内的 changelog。
总结
通过使用 git-changelog-zentao，我们可以轻松便捷地生成有效的项目 changelog 文件，并将信息同步到 zentao。希望这篇文章对各位开发者能够有所帮助。
示例代码
-- -------------------- ---- -------
-
------- ---------------
---------- --------
-------------- -- ------- --- ------- -------------------- --
------- ---------
--------------- -
----------------------- --------
--
---------- -
------------ --------------------- ------------- ---
--
--------- -----------
---------- -----
-
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005738081e8991b448e9738