npm 包 git-changelog-updated 使用教程

什么是 git-changelog-updated

git-changelog-updated 是一个能够轻松生成git仓库的更改日志的 npm 包,可以按照你的需要自定义各种过滤规则和输出格式,是一个十分好用的工具。

安装 git-changelog-updated

安装 git-changelog-updated 不是一件困难的事情,使用 npm 即可完成:

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

如何使用

创建配置文件

在项目根目录下创建一个名为 "changelog.yaml" 的配置文件,内容如下:

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

修改 package.json 文件

在 package.json 文件中添加以下内容:

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

执行命令

在命令行执行以下命令:

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

生成的 CHANGELOG.md 文件会如你的配置所示呈现。

自定义配置

git-changelog-updated 提供了很多配置项供你选择,其中比较常用的配置项有下列几个:

  • output:输出的文件名
  • sortTags:标签排序规则,支持自定义 acs(升序)和 desc(降序)两种排序方式
  • template:输出格式,支持 compactfull 两种格式

结束语

通过本文的介绍,你已经了解了 git-changelog-updated 的基本用法。希望这个小工具能够对你更好的进行版本管理、发布管理带来帮助。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/600562a381e8991b448dfd8f


猜你喜欢

  • npm 包 homebridge-gpioswitch 使用教程

    介绍 homebridge-gpioswitch 是一个基于 npm 包开发的 homekit 控制开关的工具,可以直接安装到 Raspberry Pi 或其他 SBC 上,使用 GPIO 控制开关状...

    3 年前
  • npm 包 react-native-physics 使用教程

    简介 react-native-physics 是一款 React Native 的物理引擎库,它可以帮助开发者实现各种物理交互效果。本文将介绍如何使用 react-native-physics,让你...

    3 年前
  • npm 包 fingerprint-js 使用教程

    简介 fingerprint-js 是一个用于在浏览器中生成客户端唯一指纹的 npm 包。它可以收集访问者的浏览器信息、硬件详细信息和操作系统信息,并加以处理以生成唯一的指纹。

    3 年前
  • npm 包 ddv-server-mustache-1-0 使用教程

    npm 包 ddv-server-mustache-1-0 使用教程 前言 现在,前端开发越发普及,越来越多的依赖库和框架被广泛使用。npm 作为前端包管理工具,给前端开发带来了极大的方便。

    3 年前
  • npm 包 @gaearon/react-live 使用教程

    什么是 @gaearon/react-live? @gaearon/react-live 是一个基于 React 的可编辑实时编译器。它用于前端开发中,可以让开发者实时预览代码的效果,方便调试和撰写文...

    3 年前
  • npm 包 @sergio8016/platzon 使用教程

    前言 在前端开发中,我们常常需要处理字符串,例如对字符串进行格式化、翻译、加密等操作。而 @sergio8016/platzon 正是一个处理字符串的 npm 包,它可以将输入的字符串根据一定规则进行...

    3 年前
  • 使用 injestdb-level npm 包来实现后端数据存储

    简介 injestdb-level 包是一个 Node.js 的 npm 包,它提供了一种在后端实现数据存储的方法。它基于 levelup 包,同时提供了一个类似于 mongodb 的 Documen...

    3 年前
  • npm 包 react-pattern-match 使用教程

    在现代前端开发中,React 已经被广泛应用于构建高效、可扩展的单页应用程序。在使用 React 进行编码时,我们经常会遇到需要处理大量数据的情况,此时使用模式匹配可以大大简化代码,并提高程序的可读性...

    3 年前
  • npm 包 dsp.js-browser 使用教程

    前言 在前端领域,JavaScript 的应用非常广泛,而音频处理是其中一个比较热门的领域。虽然 JavaScript 自身提供了一些基本的音频处理功能,但是如果想要实现更加高级的音频特效,就需要借助...

    3 年前
  • npm 包 pollpoll 使用教程

    Pollpoll 是一个非常实用的 npm 包,可以用于在网站或应用程序中创建投票功能。在这份教程中,我们将了解如何使用该包及其相关功能。 安装 在使用 pollpoll 包之前,我们需要先安装它。

    3 年前
  • npm 包 react-portal-target-fork 使用教程

    React-portal-target-fork 是一个用于在 React 应用程序中渲染一个弹出框的 npm 包。它具有多种功能,可以让你在应用程序内部渲染内容。

    3 年前
  • npm 包 file-type-es5 使用教程

    在前端开发中,文件上传是一个不可避免的需求,而正确地处理上传文件的类型则更是必须的。file-type-es5是一个能够识别并返回上传文件类型的npm包,使用它可以方便地判断文件类型,从而进行后续处理...

    3 年前
  • npm 包 oauth2-js-lib 使用教程

    简介 oauth2-js-lib 是一个基于 JavaScript 的包,旨在帮助开发人员快速构建使用 OAuth2 协议的客户端。它提供了一组方法,用于处理 OAuth2 授权流程、令牌管理和 AP...

    3 年前
  • npm 包 ingestdb-level 使用教程

    前言 在前端开发中,我们常常需要使用到数据库。而在使用数据库时,我们经常需要用到数据导入的功能。为了方便开发者进行数据导入操作,npm 上出现了许多相关的包,其中一个值得推荐的 npm 包是 inge...

    3 年前
  • npm 包 room-squares 使用教程

    介绍 room-squares 是一款用于生成包含随机方块的组合的 npm 包,其可以用于网站或游戏开发中,例如调色板中的小方块、俄罗斯方块等。 在本教程中,您将学习如何使用 room-squares...

    3 年前
  • npm 包 @orchejs/validators 使用教程

    在前端开发中,数据的校验是非常重要的一步。@orchejs/validators 是一个能够帮助我们快速实现数据校验的 npm 包,它提供了一些常见的校验方法,覆盖了很多数据类型和场景,并且极易使用和...

    3 年前
  • npm 包 beaker-profiles-api 使用教程

    在前端开发中,我们经常需要操作用户的个人信息,比如用户登录、用户资料修改等。而 beaker-profiles-api 就是一个非常方便的 npm 包,可以用于管理用户的个人信息,包括创建用户账户、获...

    3 年前
  • npm 包 hubot-kitsu 使用教程

    前言 在实际前端开发中,我们经常需要使用到各种工具来简化我们的工作流程。其中,npm 绝对是我们最常使用的包管理工具之一。而在 npm 的众多包中,hubot-kitsu 是一款非常实用的工具,可以帮...

    3 年前
  • npm 包 normalize-indent 使用教程

    在前端开发中,代码缩进风格是许多开发者非常在意的问题。不同的开发人员使用不同的缩进方式,这可能会给合作开发带来很多困难。同时,不同的文本编辑器和 IDE 也会自动插入缩进符号,导致代码的缩进混乱。

    3 年前
  • npm 包 systemjs-plugin-empty 使用教程

    当我们在开发前端应用时,经常会使用到一个叫做 SystemJS 的库,它是一个模块加载器,可以让我们在浏览器环境里加载不同的模块。而在使用 SystemJS 时,我们经常需要引用一些外部库或组件,这些...

    3 年前

相关推荐

    暂无文章