在前端开发中，我们常常需要将自己的 npm 包发布到 GitHub，为了方便用户使用和管理，我们需要在发布时加入版本号和更新日志。但是手动更新版本号和更新日志的过程是非常繁琐的，需要耗费大量的时间和精力。因此，我们可以使用 npm 包 release-to-github-with-changelog 来自动化这个过程，本文将会介绍 release-to-github-with-changelog 的使用教程。
什么是 release-to-github-with-changelog？
release-to-github-with-changelog 是一个 npm 包，它可以帮助我们自动生成版本号和更新日志，同时，它也支持将生成的版本号和更新日志自动提交到 GitHub。使用 release-to-github-with-changelog，我们可以将发布流程自动化，从而提高我们的开发效率。
安装
安装 release-to-github-with-changelog 很简单，只需要在命令行中执行以下命令即可：
npm install -g release-to-github-with-changelog
使用方法
使用 release-to-github-with-changelog 的过程主要分为以下几步：
- 配置
release-to-github-with-changelog - 生成版本号和更新日志
- 发布到 GitHub
配置 release-to-github-with-changelog
在使用 release-to-github-with-changelog 之前，我们需要先进行一些配置。首先，我们需要在 GitHub 上创建一个 Personal access tokens。打开 GitHub 的 Personal access tokens 页面，点击 Generate new token 按钮，然后在弹出的页面中勾选 repo 和 write:packages 权限，最后点击 Generate token 按钮即可。
然后，我们需要将这个 token 添加到我们的环境变量中。在命令行中输入以下命令：
export GITHUB_TOKEN=[你的 Personal access tokens]
接下来，我们需要在 package.json 文件中添加一些配置项。在 package.json 文件中添加以下内容：
-- -------------------- ---- -------
-
------------- -
------- ------
------ ---- ------ ------
--
------- -
------ ---- ------ ------ ----
--
----------- ---- ------ ------
-将其中的 "[你的 GitHub 仓库地址]"、"[你的 GitHub Issues 地址]"、"[你的 GitHub 主页地址]" 替换为你的实际地址即可。
生成版本号和更新日志
在配置完 release-to-github-with-changelog 后，我们就可以开始生成版本号和更新日志了。在命令行中输入以下命令：
release-to-github-with-changelog
这个命令会自动为我们生成版本号和更新日志，并将它们保存到对应的文件中。
发布到 GitHub
在生成版本号和更新日志后，我们就可以将自己的 npm 包发布到 GitHub 上了。在命令行中输入以下命令：
npm publish --access public
这个命令会自动将我们的 npm 包发布到 npm 仓库，并将我们生成的版本号和更新日志自动提交到 GitHub。用户可以在 GitHub 上查看更新日志，方便地了解本次更新的内容。
示例代码
以下是一个使用 release-to-github-with-changelog 的示例代码：
-- -------------------- ---- -------
-
------- -----------------
---------- --------
-------------- --- --- ---------
------- -----------
---------- -
------- ----- -------- -- ---- ----------- -- ---- ---
---------- --------------------------------- -- --- ------- -------- -------
--
----------- -
------
---------
--
--------- ----- ------
---------- ------
------------- -
------- ------
------ ---- ------ ------
--
------- -
------ ---- ------ ------ ----
--
----------- ---- ------ ------
-其中，scripts 部分中的 release 命令用于生成版本号和更新日志，然后发布到 GitHub。
总结
在本文中，我们介绍了如何使用 release-to-github-with-changelog 将自己的 npm 包发布到 GitHub 上。通过使用 release-to-github-with-changelog，我们可以将发布流程自动化，从而提高我们的开发效率。希望本篇文章对你有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedca67b5cbfe1ea06123f9