前言
在软件开发过程中，版本迭代是不可避免的。每次版本迭代，都需要对代码进行修改，更新文档。其中，更新文档是一个比较繁琐的任务，需要我们手动记录每个版本的变化，包括新增的功能、修改的 Bug、删除的功能等等。如何高效地记录变化，减少人工错误，提高效率，成为了我们需要面对的问题。
在这里，我们要介绍一个前端开发中非常实用的 npm 包：build-changelog。
什么是 build-changelog
build-changelog 是一个命令行工具，它可以根据 git 的提交记录自动生成项目的 changelog，并可以自动格式化、分类、排序等，生成结构清晰的 changelog 文件。借助 build-changelog，我们可以方便地记录项目的变化，方便了解版本间的差异与发行说明。
如何使用 build-changelog
安装
首先，我们需要使用 npm 安装 build-changelog：
npm install build-changelog -D
配置脚本
在使用 build-changelog 前，我们需要在 package.json 中配置一些脚本：
{
"scripts": {
"changelog": "build-changelog --tag v --message chore: release --repo gitlab.com/repo/project.git --output ./CHANGELOG.md"
}
}其中，--tag 表示标记版本的前缀，--message 表示打版本 tag 的 commit message，--repo 表示项目的远程仓库，--output 表示生成的 changelog 文件路径。可以根据项目实际情况进行调整。
打标签
在生成 changelog 前，我们需要使用 git 打对应的 tag。例如我们要记录版本号为 1.0.0 的变化，我们需要使用以下命令：
git tag -a v1.0.0 -m "release v1.0.0"
生成 changelog
打完 tag 后，我们就可以在终端运行 changelog 脚本生成 changelog 了：
npm run changelog
生成的 changelog 文件内容如下：
-- -------------------- ---- ------- - ------ --- -- ---------------------------------------------------------- ------------ --- -------- - --- -------- - --- -------- --- --- ----- - --- ---- - --- ---- --- -------- ------- - ------ -------- -- ---
总结
通过使用 build-changelog，我们可以方便地生成并维护项目的 changelog，避免繁琐的手动记录，减少人工错误，提高效率。希望这篇文章对你有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066c8dccdc64669dde54da