npm 包 tagged-git-commits 使用教程

阅读时长 3 分钟读完

Tagged-git-commits 是一个在 git 操作时用于生成语义化版本号的 npm 包。它能够依据当前 git 的 tag 和 commit 日志统计版本号,并在代码发布到远程仓库时自动生成标记。

安装

Tagged-git-commits 可以通过 npm 包管理器进行安装,通过以下命令即可完成安装:

使用

在项目根目录下执行以下命令,即可自动生成版本号,包括 MAJOR、MINOR、PATCH:

tagged-git-commits 提供了以下参数用于个性化版本号:

  • -c, --commit: 显示 commit 信息。
  • -g, --gitDescribe: 显示 git 描述。
  • -t, --tag: 添加当前 tag。
  • -v, --version: 显示 tagged-git-commits 版本号。

示例代码

以下是一个示例项目,配置了 tagged-git-commits 并且使用了自动生成的版本号:

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

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

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

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

在上述代码中,版本号被存储在 version.json 中。

如果项目的根目录中没有 version.json 文件,因为 tagged-git-commits 的自动更新能力,每一次运行 tagged-git-commits 都会生成一个新的版本号,包括 MAJOR、MINOR、PATCH。

当我们在代码发布到远程仓库时,可以通过以下命令生成 tag:

其中 ${VERSION} 代表运行 tagged-git-commits 后自动生成的版本号。

结论

Tagged-git-commits 是一个用于生成语义化版本号的工具,能够极大地简化版本号处理的工作,进一步带来更加高效的版本控制过程。通过本文的学习,相信读者对于该工具的使用已经有了一定的认识和掌握,那么就尝试使用它吧!

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

纠错
反馈