发布一个项目时，编写详细的版本发布日志是必要的，但是在管理和维护项目时，经常会遇到版本发布日志的维护繁琐和不一致的问题。@release-notes/node 是一个简单易用的 npm 包，可以帮助开发者轻松生成版本发布日志，并将其与代码库解耦，为维护项目和协作提供实用的工具。
什么是 @release-notes/node
@release-notes/node 是一个用于生成版本发布日志的 npm 包。该包提供了一个命令行工具，可以生成 Markdown 格式的版本发布日志，包括已添加的功能、bug 修复和其他变更。
安装 @release-notes/node
@release-notes/node 可以通过 npm 安装。
在命令行中，输入以下命令：
npm install -g @release-notes/node
如何使用 @release-notes/node
命令行工具
使用命令行工具生成版本发布日志：
首先，进入要生成发布日志的本地代码库。
然后，使用以下命令生成发布日志：
release-notes
使用该命令不提供任何参数将会生成所有未发布的版本的发布日志。
添加--pretty参数将在控制台更加美观的输出日志：
release-notes --pretty
在代码中使用 @release-notes/node
如果希望在代码中使用 @release-notes/node，可以在 JavaScript 或 TypeScript 文件中添加以下代码：
const { getReleaseNotes } = require('@release-notes/node');
const releaseNotes = await getReleaseNotes();这将返回一个包含发布日志字符串的 Promise。
请注意，在使用此方法之前，您需要在代码库的根目录创建 .releaseignore 文件，用于忽略不应包含在发布日志中的文件。它使用您在 .gitignore 文件中使用的相同语法。
生成 Gitlab 或 Github 发布日志
如果您的项目托管在 Gitlab 或 Github 上，您可以使用以下命令生成发布日志：
release-notes --provider gitlab
或
release-notes --provider github
这将从您的 Gitlab 或 Github 帐户中获取您的 API 密钥、API 地址和存储库信息，并生成发布日志。
版本发布日志示例
以下示例展示了使用 @release-notes/node 生成的版本发布日志：
-- -------------------- ---- ------- - -- ----- -- --- - --------- - ------- --- -- -- --- - --------- --- -- ---- - ----- - -----
结论
@release-notes/node 提供了一个方便的工具，使开发者能够轻松地创建版本发布日志。使用该工具，可以更好地维护项目版本，并为协作和分发做好准备。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056cc381e8991b448e6425