简介
发布版本是软件开发中必不可少的一项工作，而生成一份详细而清晰的版本发布日志则更是至关重要。Sr-release-notes-generator 就是一款用于自动生成版本发布日志的 npm 包，大大减轻了开发人员的工作量，同时还可以提高团队的协作效率。
在这篇文章中，我们将会详细介绍 sr-release-notes-generator 的使用方法，以及如何在项目中使用该 npm 包。
安装
首先，我们需要在项目中安装 sr-release-notes-generator，可以通过以下命令进行安装：
npm install sr-release-notes-generator --save-dev
安装完成后，我们需要在项目的 package.json 文件中添加以下 content 字段：
"scripts": {
"release-notes": "sr-release-notes-generator"
},
"srReleaseNotesConfig": {
"file": "RELEASE_NOTES.md",
"commitUrlFormat": "https://github.com/{owner}/{repo}/commit/{commit}",
"compareUrlFormat": "https://github.com/{owner}/{repo}/compare/{previousTag}...{currentTag}"
}其中，file 字段指定生成的版本发布日志的文件名，默认是 RELEASE_NOTES.md，不需要修改。commitUrlFormat 和 compareUrlFormat 分别指定了 git 提交的链接格式和版本对比的链接格式，需要根据项目的仓库地址进行修改。
使用
在安装和配置完成后，我们就可以在项目中生成版本发布日志了。使用命令：
npm run release-notes
等待执行完毕之后，就可以在项目目录下看到生成的 RELEASE_NOTES.md 文件。
高级用法
如果需要对版本发布日志进行自定义内容或格式，我们可以在 package.json 中添加如下配置：
"srReleaseNotesConfig": {
"file": "RELEASE_NOTES.md",
"commitUrlFormat": "https://github.com/{owner}/{repo}/commit/{commit}",
"compareUrlFormat": "https://github.com/{owner}/{repo}/compare/{previousTag}...{currentTag}",
"template": "<h1>版本发布日志 {currentTag}</h1>\n\n<ul>{{#each commits}}\n<li><a href=\"{{../commitUrlFormat}}\" target=\"_blank\">{{hash}}</a>: {{message}}</li>\n{{/each}}</ul>"
}在 template 字段中，我们可以指定版本发布日志的模板格式，使用 handlebars 渲染模板。模板中可以使用的变量有：
currentTag当前版本 tag 名称previousTag上一版本 tag 名称commits本次版本中的提交记录，数组格式，包含以下属性：hash提交记录的 hash 值message提交记录的信息date提交记录的日期
示例代码
下面是一个完整的 package.json 示例代码：
-- -------------------- ---- -------
-
------- ---------------
---------- --------
---------- -
---------------- ----------------------------
--
----------------------- -
------- -------------------
------------------ ----------------------------------------------------
------------------- -------------------------------------------------------------------------
----------- ----------- -------------------------------- ----------------- ------------------------------- ------------------------------- ---------------------------------
--
------------------ -
----------------------------- --------
-
-总结
通过使用 sr-release-notes-generator，我们可以快速地生成版本发布日志，减轻开发人员的工作量，提高团队的效率。在这篇文章中，我们详细介绍了 sr-release-notes-generator 的安装、配置、使用以及高级用法，希望能够对你的开发工作有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60057c4381e8991b448ebc84