简介
automatic-release-notes 是一款自动生成 Github 发布日志的 npm 包，可以大大减轻开发者编写更新日志的负担，同时也可以为项目提供更加直观的版本更新信息。
在本篇文章中，我们将为大家讲解如何使用 automatic-release-notes，以及如何将其集成到我们的项目中。
安装
要安装 automatic-release-notes，我们只需要执行以下命令：
npm install --save-dev automatic-release-notes
配置
在使用 automatic-release-notes 之前，我们需要在项目根目录下创建一个名为 .releaserc.json 的文件，并在其中编写一些必要的配置信息。
-- -------------------- ---- -------
-
---------------------- -----------------
---------------------- - ----- -----
----------- -------------------------
------- ---------------
----------- -
---------- -
----------- -----------------------
------- ----------------------
-
-
-我们可以看到，.releaserc.json 文件中包括了以下配置项：
- commitMessagePrefix：为自动化工具生成的提交信息添加前缀，以便于识别。
- commitMessageSuffix：为自动化工具生成的提交信息添加后缀，用于跳过某些 CI 持续集成工具。
- template：指定用于生成发布日志的模板文件。
- file：指定发布日志文件的名称以及路径。
- branches：指定不同分支的配置信息，比如说我们在 develop 分支上的更新可能需要更加详细。
使用
在我们配置好了 automatic-release-notes 的环境之后，我们就可以开始使用它了。
生成发布日志
执行以下命令，可以生成基于最新 tag 版本和当前版本的发布日志：
npx automatic-release-notes
执行完成后，会在我们的项目根目录下生成一个 CHANGELOG.md 文件，其中包含了最近版本的修改说明。
发布版本
执行以下命令，可以生成一个新的 tag 版本，同时也会自动生成相应的发布日志：
npm run release
需要注意的是，在使用这个命令之前我们需要保证我们的代码已经被更新到了最新的版本，并且我们需要先提交所有的更改。另外，我们在执行该命令之前，也可以在 package.json 文件中添加一些配置信息：
{
"release": {
"branches": ["main"],
"preRelease": "alpha",
"postScript": "echo 'Post script'"
}
}在 release 配置项中，我们可以指定自动化工具的一些重要参数，例如可视化版本发布的分支、预发布版本名和后置脚本等。
集成到项目中
最后，为了方便我们日常的使用，我们可以将 automatic-release-notes 集成到我们的项目中，使用如下命令自动生成日志：
npm run changelog
在 package.json 中，添加以下脚本：
{
"scripts": {
"changelog": "npx automatic-release-notes"
}
}这样，我们每次执行该命令，就可以在更改了代码后生成最新的发布日志了。
结论
在本文中，我们为大家讲解了如何使用 automatic-release-notes 自动化工具来生成发布日志，以及如何将其集成到我们的项目中，可大大提升我们的开发效率。
同时也要注意，使用自动化工具来协助我们完成繁琐工作的时候，我们需要在配置环节花费更多的心思来确保工具满足我们的需求。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055bd581e8991b448d978a