npm 包 @jpmschuler/conventional-changelog-typo3 使用教程

阅读时长 3 分钟读完

什么是 @jpmschuler/conventional-changelog-typo3

@jpmschuler/conventional-changelog-typo3 是一个基于 Angular Commit 规范,提供生成 Typo3 Changelog 的工具。该工具可以根据项目的 Git Commit 记录生成符合 Typo3 格式规范的 Changelog。

安装和配置

在项目根目录中执行以下命令进行安装:

安装完成后,在 package.json 中新增以下配置:

其中,-p 参数指定使用的配置为 typo3-i 参数指定生成的 Changelog 文件名称为 CHANGELOG.md-s 参数表示在生成 Changelog 后立即将其推送到 Git 仓库。

使用

在 Git Commit 时,需要按照 Angular 规范进行 Commit 记录。例如:

在需要生成 Changelog 时,在项目根目录下执行以下命令即可:

该命令将根据 Git Commit 记录生成符合 Typo3 格式规范的 Changelog,然后将其更新到 CHANGELOG.md 文件中。

若需要生成指定版本的 Changelog,可以执行以下命令:

其中,<version> 为指定的版本号。

示例代码

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

总结

通过使用 @jpmschuler/conventional-changelog-typo3 工具生成符合 Typo3 格式规范的 Changelog,可以方便地记录和展示项目的变更历史。同时,遵循 Angular 规范的 Commit 记录也能提高项目的可维护性。

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

纠错
反馈