简介
grunt-github-changes 是一个基于 Github API 的 Grunt 插件，它可以获取 Github 上某个项目的最新版本 ChangeLog ，并将其生成为 markdown 格式的文件，方便项目开发者查看和处理。
安装
想要使用 grunt-github-changes 插件，需要先在电脑上安装 Grunt 。在安装 Grunt 后，可以通过 npm 命令行工具来进行插件的全局安装。
npm install grunt-github-changes --save-dev
配置
在 Gruntfile.js 文件中添加以下配置信息：
-- -------------------- ---- -------
-------------- - --------------- -
-------------------------------------------
------------------
-------------- -
----- -
-------- -
----------- -------------
----- ------------------
-------- --------
-
-
-
---
----------------------------- -------------------
--在配置文件中，需要注意以下几个参数：
- repository：需要生成 ChangeLog 的 Github 项目名称，格式为 owner/repo
- user：Github 用户名
- version：需要生成 ChangeLog 的项目版本号
命令行使用
直接运行 grunt 命令即可生成 ChangeLog
grunt githubChanges
端到端使用示例代码
下面给出一个从 Github 上获取 ChangeLog 并发送到指定邮件的端到端使用示例代码
-- -------------------- ---- -------
----- ---------- - ----------------------
----- ----- - -----------------
----- ----- - --------------------------
----- --------- - ----------------------------
-------- --------
----- -
----- ------------------
----- -------
-
---
----- -- - --- -------
----- ------------------
----- --------
----- -----------------
----- ----
---- -----
---
-------------------- -------- -----------------------------
---- ------- --------- --------------------
-------- -------------- --------- --------- -
-- ----- ------ -------------------
-------------------------- -- -
----- ------- -------- - ----------------
-------------------- -- -
-- ----------------
-- ------------------------------- --- --- -
----- ------- - -
----- ------------------ -- ------ ---
----------- ------------- -- ------ ----
-------- --- - --------------- -------- -- -- --------- ---
--
------------------
------ -----
----- ------------------
----- -
------ ----------
---- ----------
--
--------------- -----
-- -- -- -
----- --------- - --------------------------------
--------------------
----- ------------------
--- ----------------
-------- ------- -----------
----- ---------
-- --------------- ----- -
-- ------- -
-------------------
- ---- -
------------------ ----- - - ---------------
-
---
---
-
---
---
-总结
使用 grunt-github-changes 可以方便地获取 Github 项目的 ChangeLog，同时也可以通过邮件等形式将改动通知给团队成员。需要注意的是，在使用插件时需要先全局安装 Grunt 。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedcaadb5cbfe1ea061248f