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

什么是 @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


猜你喜欢

  • NPM包cfn-nest的使用教程

    在使用AWS CloudFormation部署服务器less Web应用或者其他AWS云资源时,嵌套栈是维护云代码的重要工具之一。然而,AWS的嵌套堆栈及其编写的开销很大,难以维护。

    4 年前
  • npm 包 @behaver/orbital-node-position 使用教程

    前言 在天文学中,轨道定位是非常重要的一个概念。在前端开发中,应用轨道定位用于完成关于星球轨道等的模拟和计算。而 @behaver/orbital-node-position 就是一个 npm 包,可...

    4 年前
  • npm 包 0.css 使用教程

    什么是 0.css 0.css 是一款极简的 CSS 库,压缩后仅有 357B,它采用了一些比较新奇的 CSS 实现方式,深度挖掘了 CSS 的用法,让 CSS 更加语义化,同时提供了一些常用的样式,...

    4 年前
  • npm 包 mongoose-model-faker 使用教程

    在前端开发中,使用模拟数据是非常常见的。然而,手动创建模拟数据是一项费时费力的任务。为了解决这个问题,我们可以使用一个叫做 mongoose-model-faker 的 npm 包来轻松地生成模拟数据...

    4 年前
  • npm 包 @march/sayhi 使用教程

    简介 在前端开发中,我们通常会使用各种各样的代码库来帮助我们实现特定的功能。而这些代码库通常是以 npm 包的形式发布的。本文将介绍一个名为 @march/sayhi 的 npm 包,它可以帮助我们在...

    4 年前
  • npm 包 @quantalytix/react-dropdownbox 使用教程

    在前端开发中,下拉框是一个非常常见的组件。而 @quantalytix/react-dropdownbox 是一个基于 React 实现的下拉框组件, 其中封装了多种下拉框框架,使用该组件能够快速的实...

    4 年前
  • npm 包 packdoc 使用教程

    在前端开发过程中,我们经常需要将自己写的代码打包成一个 npm 包,供其他人使用。其中一个重要的环节就是写好明确的文档,让用户可以轻松地使用我们的 npm 包。而 packdoc 就是一个非常好用的 ...

    4 年前
  • npm 包 scrollclass 使用教程

    前言 在网页设计中,滚动条是一个很重要的组件,用于帮助用户浏览长页面。然而通常情况下,滚动条的样式和行为不够个性化,需要额外编写 CSS 和 JavaScript 代码来实现。

    4 年前
  • npm 包 smartapi-oasgraph-cli 使用教程

    介绍 smartapi-oasgraph-cli 是一个用于将 OpenAPI 规范的 API 转换成 GraphQL 服务的命令行工具。它可以快速地为您生成 GraphQL schema,以便您可以...

    4 年前
  • npm 包 lib-of-commons 使用教程

    npm 包 lib-of-commons 使用教程 lib-of-commons 是一款非常实用的 npm 包,它主要用来提取出前端开发中比较常用的一些工具函数和工具类。

    4 年前
  • npm 包 smartapi-oasgraph 使用教程

    简介 在前端开发中,我们经常需要使用 API 来获取远程数据。但是在使用 API 前,我们需要了解这些 API 的功能和参数。OpenAPI Specification (OAS) 是一种描述 API...

    4 年前
  • NPM 包 Selenium-DOM 使用教程

    Selenium-DOM 是一个强大的 NPM 包,它可以帮助前端开发人员自动化测试和更好地管理 DOM 元素。本文将介绍如何安装和使用 Selenium-DOM,以及一些它的高级方法。

    4 年前
  • npm 包 custom-sidenav-js 使用教程

    随着前端技术日新月异的发展,越来越多的开源项目和 npm 包被发布到了互联网上。其中,custom-sidenav-js 是一个非常实用的 npm 包,它可以帮助我们快速地实现侧边栏导航功能。

    4 年前
  • npm 包 @kredati/ludus-assert 使用教程

    概述 @kredati/ludus-assert 是一款基于 Jest 和 Chai 的 Node.js 断言库。它不仅提供了常规的断言方法,还提供了一些额外的实用功能,如在错误日志中添加额外信息、自...

    4 年前
  • npm 包 makerbot-rpc 使用教程

    在前端开发中,经常涉及到和后端服务器进行通信,而 makerbot-rpc 是一个可以帮助我们处理与 MakerBot 打印机进行通信的 npm 包。本文将为大家介绍如何使用 makerbot-rpc...

    4 年前
  • npm 包 dealer-sorter 使用教程

    dealer-sorter 是一个基于 JavaScript 的 npm 包,可用于排序一组经销商数据。本文将为你介绍 dealer-sorter 的安装、配置和使用方法,并为你提供示例代码。

    4 年前
  • npm 包 boolean-filter-obj 使用教程

    简介 在前端开发过程中,我们经常需要根据一些条件过滤我们的数据。当我们的条件比较复杂时,可以使用 boolean-filter-obj 这个 npm 包来简化我们的代码和提高代码的可读性和可维护性。

    4 年前
  • npm 包 workflow-shell 使用教程

    前言 近年来,前端领域的成长非常迅速。越来越多的开发者开始采用前端技术开发应用程序。NPM(Node Package Manager)作为 Node.js 的包管理工具,也逐渐地成为前端开发人员常用的...

    4 年前
  • npm 包 @lbennett/eslint-plugin-turbolinks-event-handling 使用教程

    在前端开发中,代码规范一直是一个重要的问题。其中,ESLint 是一个流行的 JavaScript 代码检查工具,可以帮助我们发现代码中的一些潜在问题。而使用较新的技术时,ESLint 对代码的支持可...

    4 年前
  • npm 包 argumentsof 使用教程

    在前端开发中,我们经常需要处理函数的参数。而在处理函数参数时,有时候我们需要获取函数的所有参数,而有时候我们只需要获取某些参数。这时就需要使用一个 npm 包叫做 argumentsof 来达到我们的...

    4 年前

相关推荐

    暂无文章