npm 包 lerna-changelog-label-schema 使用教程

阅读时长 3 分钟读完

简介

lerna-changelog-label-schema 是一个 npm 包,它提供了一个标签和语义版本的规范,以帮助开发者更清晰地跟踪版本变化和生成 CHANGELOG。本教程将介绍如何使用 lerna-changelog-label-schema。

安装

要安装 lerna-changelog-label-schema,可以使用以下命令:

语义版本

1.0.0 的版本号表示为 MAJOR.MINOR.PATCH 的形式,其中:

  • MAJOR 增加表示一个不兼容的 API 更改。
  • MINOR 增加表示向后兼容的新功能。
  • PATCH 增加表示向后兼容的缺陷修复。

lerna-changelog-label-schema 使用这种 MAJOR.MINOR.PATCH 的版本号规范。在你的项目中,你可以通过运行 npm version 命令来增加版本号,如下所示:

标签规范

lerna-changelog-label-schema 还提供了一组标签,以更好地定义版本变化和生成 CHANGELOG。这些标签包括:

  • feat: 新功能添加
  • fix: 缺陷修复
  • perf: 性能优化
  • refactor: 重构代码
  • docs: 文档更新
  • test: 测试用例更新
  • build: 构建工具或运行时依赖更新
  • chore: 其他更改(如代码格式化或文档归档)

这些标签可以在 commitmessage 中使用,例如:

标签可以与语义版本号一起使用,例如:

自动生成 CHANGELOG

lerna-changelog-label-schema 还支持自动生成 CHANGELOG。可以使用以下命令生成 CHANGELOG:

运行该命令将使用 Git 历史记录并基于标签生成新的 CHANGELOG。默认情况下,CHANGELOG 将生成为标准 Markdown 格式。可以使用 --format 选项来指定其他格式,例如 --format=html

示例代码

定义一个简要的 package.json

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

定义一个 commit

生成新的 CHANGELOG:

结束语

以上是使用 lerna-changelog-label-schema 包的教程,它提供了一组标签和语义版本的规范,以帮助开发者更清晰地跟踪版本变化和生成 CHANGELOG。希望这篇文章能够帮助你更好地了解如何使用该包。

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

纠错
反馈

纠错反馈