npm 包 git-history-changelog 使用教程

阅读时长 4 分钟读完

git-history-changelog 是一个基于 Git 历史记录自动生成更新日志的工具。在前端领域中,我们经常需要与 Git 打交道,并且需要生成更新日志。而 git-history-changelog 可以让我们更加方便地生成更新日志。

安装

我们可以使用 npm 进行安装:

使用方法

生成更新日志

在你的 Git 项目中,你可以使用以下命令来生成更新日志:

其中,[options] 是一些可选参数,比如:

  • --outfile:输出文件路径,指定了该参数,更新日志将会被写入该文件中,而不是输出到终端。
  • --since:指定更新日志开始时间,支持各种 Git 日志格式,比如 yesterday1 week ago等。
  • --unreleased:忽略未发布的修改,只生成已发布的更新日志。

生成的更新日志可能长成这样:

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

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

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

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

-- ----- ------------
---- --------
- ---------- --------
- ----- -------
展开代码

集成到项目中

在你的项目中,你可以将 git-history-changelog 集成到你的构建脚本中,比如 webpack:

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

----- ------ - -
  -- ---
  -------- -
    --- ------------
      -- ------ ------------
      ----------- -------------------- ----------------
      -- -----------
      ----------- ------
      -- ---- --- -----------
      ----- ---------
      -- ------ ----
      -------- -----------------------------------
      -- ----
      ------- ----- ------
      -- ----
      ------ -------------------------
      -- ----
      ----------- -------------
      -- -------
      ------------ -----
      -- ---- ---
      -------- -----
      -- -------
      ------------ -----
      -- ------
      ----------- -----
      -- ----------
      -------- -----
    --
  -
--
展开代码

示例代码

以下代码是在终端中使用 git-history-changelog 生成更新日志的示例:

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

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

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

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

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

-- ----- ------------
---- --------
- ------- --------
展开代码

以上内容应该让你对 git-history-changelog 有一个较为清楚的了解,并能够快速实践。祝你好运!

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005738981e8991b448e97cc

纠错
反馈

纠错反馈