npm 包 grunt-github-changes 使用教程

简介

grunt-github-changes 是一个基于 Github API 的 Grunt 插件，它可以获取 Github 上某个项目的最新版本 ChangeLog ，并将其生成为 markdown 格式的文件，方便项目开发者查看和处理。

安装

想要使用 grunt-github-changes 插件，需要先在电脑上安装 Grunt 。在安装 Grunt 后，可以通过 npm 命令行工具来进行插件的全局安装。

--- ------- -------------------- ----------

配置

在 Gruntfile.js 文件中添加以下配置信息：

-------------- - --------------- -
  -------------------------------------------

  ------------------
    -------------- -
      ----- -
        -------- -
          ----------- -------------
          ----- ------------------
          -------- --------
        -
      -
    -
  ---

  ----------------------------- -------------------
--

在配置文件中，需要注意以下几个参数：

  • repository：需要生成 ChangeLog 的 Github 项目名称，格式为 owner/repo
  • user：Github 用户名
  • version：需要生成 ChangeLog 的项目版本号

命令行使用

直接运行 grunt 命令即可生成 ChangeLog

----- -------------

端到端使用示例代码

下面给出一个从 Github 上获取 ChangeLog 并发送到指定邮件的端到端使用示例代码

----- ---------- - ----------------------
----- ----- - -----------------
----- ----- - --------------------------
----- --------- - ----------------------------
  -------- --------
  ----- -
    ----- ------------------
    ----- -------
  -
---
----- -- - --- -------
  ----- ------------------
  ----- --------
  ----- -----------------
  ----- ----
  ---- -----
---

-------------------- -------- -----------------------------
    ---- ------- --------- --------------------

-------- -------------- --------- --------- -
  -- ----- ------ -------------------
  -------------------------- -- -
    ----- ------- -------- - ----------------
    -------------------- -- -
      -- ----------------
      -- ------------------------------- --- --- -
        ----- ------- - -
          ----- ------------------ -- ------ ---
          ----------- ------------- -- ------ ----
          -------- --- - --------------- -------- -- -- --------- ---
        --
        ------------------
          ------ -----
          ----- ------------------
          ----- -
            ------ ----------
            ---- ----------
          --
          --------------- -----
        -- -- -- -
          ----- --------- - --------------------------------
          --------------------
            ----- ------------------
            --- ----------------
            -------- ------- -----------
            ----- ---------
          -- --------------- ----- -
            -- ------- -
              -------------------
            - ---- -
              ------------------ ----- - - ---------------
            -
          ---
        ---
      -
    ---
  ---
-

总结

使用 grunt-github-changes 可以方便地获取 Github 项目的 ChangeLog，同时也可以通过邮件等形式将改动通知给团队成员。需要注意的是，在使用插件时需要先全局安装 Grunt 。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/5eedcaadb5cbfe1ea061248f

阅读全文

猜你喜欢

  • npm 包 @pixi/filter-convolution 使用教程

    在前端开发中，经常需要对图片进行各种处理，比如滤镜效果。PixiJS 是一款非常流行的 JavaScript 游戏开发框架，它提供了丰富的滤镜效果，可以帮助开发者实现各种复杂的图像处理效果。

    4 年前
  • npm 包 @pixi/filter-cross-hatch 使用教程

    前言 @pixi/filter-cross-hatch 是一个基于 PIXI.js 的 WebGL 库的 npm 包，它提供了一种实现画像效果的滤镜，该滤镜通过应用多个倾斜的线条来模拟画笔的笔触，使得...

    4 年前
  • npm 包 @pixi/filter-crt 使用教程

    前言 @pixi/filter-crt 是 PixiJS 提供的一个 CRT 效果的滤镜，可以为你的网页或游戏界面增加一些老式电视屏幕的效果。本文将为你详细介绍如何使用这个 npm 包来实现 CRT ...

    4 年前
  • npm 包 @pixi/filter-dot 使用教程

    在前端开发中，许多项目需要使用图形效果来增强用户体验。在 Pixi.js 库中，@pixi/filter-dot 是一个非常有用的 npm 包，可以用于创建动态和交互式的点光斑效果。

    4 年前
  • npm 包 @pixi/filter-drop-shadow 使用教程

    前言 在前端开发中，经常需要对图片、文字等元素进行美化处理，给它们添加阴影效果可以增强它们的层次感和立体感。@pixi/filter-drop-shadow 是一个非常实用的 npm 包，它可以很方便...

    4 年前
  • npm 包 array.prototype.fill 使用教程

    array.prototype.fill 是 JavaScript 中一个非常有用的数组方法，可以用于将特定元素插入到数组中的指定位置。本文将详细介绍如何使用 array.prototype.fill...

    4 年前
  • npm 包 @pixi/filter-emboss 使用教程

    简介 @pixi/filter-emboss 是一个使用 PixiJS 实现浮雕滤镜的 npm 包。浮雕滤镜可以使图像中的物体边缘形成立体感，适用于增强图像的视觉效果，也可用于一些艺术创作中。

    4 年前
  • npm 包 grunt-strip 使用教程

    当我们编写前端代码时，可能会使用一些功能强大的插件库和框架。但是，有时候这些插件会包含一些多余的代码，这些代码可能对网站的性能和安全性造成一些负面影响。为了解决这个问题，我们可以使用一个名为 grun...

    4 年前
  • npm 包 @pixi/filter-glitch 使用教程

    前言 在现代 Web 开发中，前端技术的重要性早已不言自明。而作为一名前端开发工程师，偶尔也需要一些艺术设计元素来提升网页的视觉效果。于是，在这篇文章中，我们将学习如何使用一个名为 @pixi/fil...

    4 年前
  • npm 包 @pixi/filter-glow 使用教程

    介绍 @pixi/filter-glow 是一个基于 WebGL 的图片特效库，可以为图片添加发光效果。它是在 PIXI.js 的基础上进行开发的，因此需要先安装 PIXI.js 才能够使用 @pix...

    4 年前
  • npm 包 @pixi/filter-godray 使用教程

    前言 @pixi/filter-godray 是一个基于 PIXI.js 开发的光柱滤镜。如果你想要为你的网页或游戏添加一个具有神秘效果的光影效果，那么这个滤镜是一个很好的选择。

    4 年前
  • npm 包 @pixi/filter-kawase-blur 使用教程

    前言 在前端开发中，有时我们需要对图片进行处理，以达到美化、提高UI效果等目的。其中，图片模糊是很常见的处理方式之一，常用于盖住敏感信息、突出图片中的主要内容等场景。

    4 年前
  • npm 包 @pixi/filter-motion-blur 使用教程

    在现代的前端开发中，很少有人可以做到完全不依赖于任何外部工具或库。NPM (Node Package Manager) 就是其中一个最受欢迎的包管理器之一，开发人员可以使用它来轻松获取并使用数百万个可...

    4 年前
  • npm 包 @pixi/filter-multi-color-replace 使用教程

    介绍 @pixi/filter-multi-color-replace 是一个基于 PixiJS 的着色滤镜，它可以替换图像中的多个颜色。该 npm 包可在浏览器或 Node.js 环境下使用。

    4 年前
  • npm 包 @pixi/filter-old-film 使用教程

    简介 @pixi/filter-old-film 是一个基于 PIXI.js 的插件，用于对图片或者视频应用旧电影效果的滤镜效果。这个插件可以帮助开发者创造出独特的视觉效果，适用于各种前端应用程序。

    4 年前
  • npm 包 @87carats/devutils 使用教程

    简介 @87carats/devutils 是一个 npm 包，它提供了一系列的工具函数，可以帮助前端开发人员快速开发和调试应用程序。 该包提供了许多实用的方法，它们可以用于验证字符串、格式化日期、生...

    4 年前
  • npm 包 @pixi/filter-outline 使用教程

    前言 在前端开发领域，有许多优秀的框架和库帮助我们提高开发效率，其中 PixiJS 是一款功能强大、使用广泛的 2D 游戏引擎。它提供了众多的内置滤镜（Filter），方便我们快速美化或调整图片或精灵...

    4 年前
  • npm 包 @pixi/filter-pixelate 使用教程

    PixiJS 是一款用于 WebGL 和 Canvas 的 HTML5 游戏引擎，它以其高效和易于使用的 API 而闻名。@pixi/filter-pixelate 是 PixiJS 的一个非常有用的...

    4 年前
  • npm 包 @pixi/filter-radial-blur 使用教程

    npm 包 @pixi/filter-radial-blur 使用教程 前言 @pixi/filter-radial-blur 是一个非常强大的用于前端开发的 npm 包。

    4 年前
  • npm 包 grunt-bower-verify 使用教程

    前言 在前端开发中，我们经常使用诸如bower等工具来管理前端库的版本。但是有时候我们会遇到一些问题，例如我们可能会需要检查bower文件中是否有错误或者警告。在这种情况下，grunt-bower-v...

    4 年前

相关推荐

    暂无文章