在开发前端项目的过程中，我们经常需要发布我们的代码，让其他人能够使用和阅读。在Github上管理我们的代码是一个有效的方式，然而如何发布我们的代码并写明详细的更新记录呢？这就需要用到npm包grunt-github-releaser。
什么是grunt-github-releaser？
grunt-github-releaser 是一个基于Grunt的npm包，它可以自动把您的 Github 代码仓库中的 Release Notes 发布到您的 Release 页面上。这个包基于Git标签自动读取您的 Release Notes，并在您发布新的 Release 版本时自动创建 Release Notes 来更新您的 Release 页面。
如何使用grunt-github-releaser？
- 安装grunt-github-releaser
您可以在终端窗口中使用以下命令来安装grunt-github-releaser。
npm install grunt-github-releaser --save-dev
- 配置grunt-github-releaser
在您的Gruntfile.js文件中，您需要指定一个任务来使用grunt-github-releaser。以下代码为您展示了如何配置。
-- -------------------- ---- -------
------------------
-------------- -
-------- -
----------- -------------
----- -
----- -----------
--------- ----------
--
-------- -
--------- ----- ----------- ----
----- ----- ----------- ----
----- -------- ----- -- -------- --------
-
-
-
---需要注意的是，您需要填写自己的 repository。此处的下载的 tag_name 和 name都为版本号，您需要在package.json配置中的 version 字段中填写您的版本号，这样Grunt就能够自动读取您的版本号了。
- 运行grunt-github-releaser
当所有设置完毕后，在终端窗口中使用以下命令来运行grunt-github-releaser任务。
grunt githubRelease
- 查看更新记录
打开在 Github 上 Release 页面，您应该就能看到最新的 Release 版本了。
示例代码
以下代码是完整的Gruntfile.js文件，您可以直接拿来使用并指定您自己的repository。
-- -------------------- ---- -------
-------------- - --------------- -
------------------
---- ------------------------------------
-------------- -
-------- -
----------- -------------
----- -
----- -----------
--------- ----------
--
-------- -
--------- ----- ----------- ----
----- ----- ----------- ----
----- -------- ----- -- -------- --------
-
-
-
---
--------------------------------------------
----------------------------- -------------------
--结论
在项目发布时，更新记录是非常有用的，能够让用户知道您的代码是如何进行更新的，此时grunt-github-releaser这个npm包就派上了用场。我们可以通过简单地配置，就能够实现自动发布更新记录，大大减少了发布的时间和精力，提高了工作效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedcc99b5cbfe1ea061281e