前言
在现代 Web 开发中，使用 Git 进行版本控制已经成为了标配。项目迭代过程中，我们还需要生成 CHANGELOG.md 文件来记录项目的版本变更信息，以方便开发者和用户了解项目版本更新内容。本文将介绍一个使用 npm 包 git-generate-changelog 生成 CHANGELOG.md 文件的使用方法。
git-generate-changelog 简介
git-generate-changelog 是基于 conventional-changelog 和 conventional-commits 规范开发的 npm 包。它可以自动根据 Git 提交信息生成 CHANGELOG.md 文件。
安装
在使用前，需要先安装 git-generate-changelog 包。使用以下命令：
npm install -g git-generate-changelog
使用
1. 在项目根目录下执行以下命令：
git-generate-changelog > CHANGELOG.md
2. 查看 CHANGELOG.md 文件
使用文本编辑器或者 Markdown 渲染工具打开生成的 CHANGELOG.md 文件，可以看到自动生成的版本变更日志。
3. 生成指定版本数的版本变更日志
可以使用命令行参数 -n 指定生成的版本数。例如，以下命令会生成当前版本和前 5 个版本的版本变更日志：
git-generate-changelog -n 5 > CHANGELOG.md
4. 指定工作目录
使用命令行参数 --path 可以指定 git-generate-changelog 执行的工作目录。
git-generate-changelog --path=/path/to/project > CHANGELOG.md
5. 指定自定义的 conventional-changelog 配置
可以通过在项目根目录下创建 .conventional-changelog.js 文件自定义配置。在这个 JavaScript 文件中，可以自定义日志格式、根据关键字过滤提交消息等。
-- -------------------- ---- -------
-------------- - -
-------------- -
-- ---------- ------------------------------
------- --------------------------------
-- -----------
------------- -
- ----- ------- -------- ------- --
- ----- ------ -------- ------- --
- ----- ------- -------- ------- --
- ----- --------- -------- ------- --
- ----- ------- -------- ----- -
-
-
--结语
本文介绍了 npm 包 git-generate-changelog 的使用方法，它可以自动生成项目版本变更日志，方便开发者和用户了解项目版本的变更信息。通过参照本文的介绍，你可以快速入门 git-generate-changelog 的使用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005664881e8991b448e25f8