在 VS Code 中规范化 Git 提交消息并自动生成 CHANGELOG.md

1. 使用 Commitizen 规范化 Git 提交消息

首先,安装 Commitizen 和适用于 Angular 提交规范的适配器:

npm install -g commitizen
commitizen init cz-conventional-changelog --save-dev --save-exact

这样,提交信息将遵循 Angular 规范,比如 feat(新功能)、fix(修复)、docs(文档)、style(格式)、refactor(重构)、test(测试)、chore(杂务)等格式。

2. 使用 Husky 和 Commitlint 验证提交消息

安装 Husky 和 Commitlint:

npm install husky @commitlint/config-conventional @commitlint/cli --save-dev

在项目根目录创建 commitlint.config.js 配置文件:

// commitlint.config.js
module.exports = {extends: ['@commitlint/config-conventional'],
};

接着,设置 Husky 钩子来验证提交消息:

npx husky install
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'

3. 使用 standard-version 自动生成 CHANGELOG.md

standard-version 是一种用于版本管理的工具,可以基于提交历史自动生成和更新 CHANGELOG.md 文件。

安装 standard-version

npm install standard-version --save-dev

package.json 文件中添加脚本命令:

{"scripts": {"release": "standard-version"}
}

运行以下命令生成或更新 CHANGELOG.md

npm run release

每次运行 npm run releasestandard-version 会分析提交历史,根据提交类型(如 featfix)更新 CHANGELOG.md,并自动更新 package.json 中的版本号。

4. 配置 VS Code 提交流程

.vscode/settings.json 中设置如下选项,以在每次提交时自动使用 Commitizen:

{"git.enableCommitSigning": true,"git.postCommitCommand": "commitizen"
}

这样每次提交时,会自动引导用户使用 Commitizen 格式提交信息,从而保持提交信息的规范性。

总结

完成以上配置后,可以使用如下流程:

  1. 使用 git cz 替代 git commit 提交规范化的消息。
  2. 通过 npm run release 自动生成或更新 CHANGELOG.md 文件。

这样,Git 提交信息的规范性和变更日志自动化生成都可以在 VS Code 中高效实现。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/diannao/59099.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

c++模板入门

c系列模板入门 文章目录 c系列模板入门一、模板概念引入二、函数模板2.1、函数模板的概念2.2、函数模板的定义格式2.3、函数模板的使用 三、类模板1.1、什么是类模板1.2、类模板的定义格式1.3、类模板于函数模板的区别 一、模板概念引入 在程序设计中我们经常需要对两个数据进…

MyBatis-Plus中AbstractJsonTypeHandler使用小结

在 MyBatis-Plus 中, AbstractJsonTypeHandler 是一个用于处理 JSON 数据类型的抽象类。 一、作用 1. 数据库与 Java 对象之间的 JSON 数据转换 当数据库中的字段类型为可以存储 JSON 格式数据的类型(如 MySQL 的 JSON 类型、Oracle 的 CLOB 等可存储…

谷粒商城のsentinelzipkin

文章目录 前言一、Sentinel1、什么是Sentinel2、项目配置3、使用案例3.1、流控3.2、降级3.3、黑白名单设置 二、Zipkin1、什么是Zipkin2、项目配置3、整合案例 前言 本篇介绍Spring Cloud Ali的sentinel组件,用于对微服务的熔断降级,以及链路追踪zipkin的…

Freertos学习日志(1)-基础知识

目录 1.什么是Freertos? 2.为什么要学习RTOS? 3.Freertos多任务处理的原理 1.什么是Freertos? RTOS,即(Real Time Operating System 实时操作系统),是一种体积小巧、确定性强的计算机操作系统…

富格林:拆穿欺诈套路平稳出金

富格林认为,投资者产生的欺诈亏损多半是由于被出金骗局的花言巧语所迷惑,以为真的躺着就可以轻轻松松赚大钱,结果最后发现连本金都追不回来。事实上,投资市场并不像大家想得那么简单,要想拆穿欺诈套路实现平稳出金&…

2. Flink快速上手

文章目录 1. 环境准备1.1 系统环境1.2 安装配置Java 8和Scala 2.121.3 使用集成开发环境IntelliJ IDEA1.4 安装插件2. 创建项目2.1 创建工程2.1.1 创建Maven项目2.1.2 设置项目基本信息2.1.3 生成项目基本框架2.2 添加项目依赖2.2.1 添加Flink相关依赖2.2.2 添加slf4j-nop依赖2…

TIA 中用 GSD 方式组态 ET200SP 安全模块时如何用 S7-FCT 分配安全目标地址

1 概述 用 GSD 方式组态的 ET200SP 的分布式从站上,现在可以使用安全模块(早期 是无法支持),这种用法对 ET200SP 接口模块的版本和编程软件的版本都有要求。 ET200SP 故障安全模块可通过 GSD 文件用于以下接口模块: …

0,国产FPGA(紫光同创)-新建PDS工程

国产FPGA正在蓬勃发展,紫光同创FPGA是大家竞赛时经常遇到的一款国产FPGA,本专栏从IP核开始一直到后续图像处理等。 开发板:盘古50K标准板 1,新建PDS工程 点击File(1),然后是New Projects&#…

【已解决】群晖docker无法删除容器 “Error response from daemon: container” 终极解决办法

【已解决】群晖docker无法删除容器终极解决办法 问题描述 DSM7.2无法通过docker rm -f删除无法通过Container Manager界面删除删除容器会报错:Error response from daemon: container 01eb61e74e80d49ae6273a8ca0ced196bb4be5513acce708701fe4c69cabf86e: driver…

视频Qoe测量学习笔记(一)

目录 流媒体协议详解 RTSP:实时流式协议 RTCP:实时运输控制协议 RTP:实时运输协议 H.264 流媒体协议详解 RTSP:实时流式协议 由IETF MMusic小组开发,已成为互联网建议标准[RFC 2326]。RTSP本身并不传送数据&…

计算机视觉常用数据集Foggy Cityscapes的介绍、下载、转为YOLO格式进行训练

我在寻找Foggy Cityscapes数据集的时候花了一番功夫,因为官网下载需要用公司或学校邮箱邮箱注册账号,等待审核通过后才能进行下载数据集。并且一开始我也并不了解Foggy Cityscapes的格式和内容是什么样的,现在我弄明白后写下这篇文章&#xf…

单向函数、单向陷门函数、困难问题

1、单向函数 设函数 yf(x) , 对于给定的x,计算出y很容易;对于给定的y,计算出x很难。 2、单向陷门函数 设函数 yf(x) ,且f有陷门, 对于给定的x,计算出y很容易;对于给定的y&#…

前端将网页转换为pdf并支持下载与上传

1.pdf下载 handleExport() {const fixedH document.getElementById("fixed-h");const pageOne document.getElementById("mix-print-box-one");const pageTwo document.getElementById("mix-print-box-two");fixedH.style.height 30vh;pageO…

js 获取当前时间与前一个月时间

// 获取当前时间的毫秒数 var currentTimeMillis new Date().getTime();// 获取前一个月的Date对象 var dateLastMonth new Date(); dateLastMonth.setMonth(dateLastMonth.getMonth() - 1);// 获取前一个月的毫秒数 var timeMillisLastMonth dateLastMonth.getTime();conso…

Linux_02 Linux常用软件——vi、vim

vi编辑器有三种主要模式,每种模式的功能和用途不同: 一、命令模式 (Command Mode): - 启动 vi 时默认进入此模式。 - 你可以在此模式下移动光标,输入各种命令(如删除、复制、粘贴等)。 yy:…

C++设计模式结构型模式———装饰模式

文章目录 一、引言二、装饰器模式三、总结 一、引言 装饰模式是一种结构型设计模式, 允许你通过将对象放入包含行为的特殊封装对象中来为原对象绑定新的行为。 该模式展现出了运行时的一种扩展能力,以及比继承更强大和灵活的设计视角和设计能力&#x…

「iOS」——知乎日报一二周总结

知乎日报仿写 前言效果Manager封装网络请求线程冲突问题下拉刷新添加网络请求的图片通过时间戳和日期格式化获取时间 总结 前言 前两周内容的仿写,主要完成了首页的仿写,进度稍慢。 效果 Manager封装网络请求 知乎日报的仿写需要频繁的申请网络请求&am…

Profinet、Ethernet/IP 工业以太网无线通信解决方案

在工业现场,我们常常会面临这样的困扰:两个PLC之间、PLC 跟远程IO之间或者PLC 跟伺服之间由于种种原因不方便布线,严重影响了通讯效率和生产进程。为了解决这一难题,三格电子设计了一款工业以太网无线网桥,这款无线网桥…

核心概念解析Caffeine 缓存模型与策略

1. 简介 什么是 Caffeine Caffeine 是一个高性能的 Java 缓存库,专为提高内存缓存的效率和灵活性而设计。它由 Google 的 Guava Cache 项目启发,并提供了更高的性能和更丰富的功能集。Caffeine 以其卓越的缓存命中率和内存管理能力而广受欢迎&#xff…

GaussDB Ustore存储引擎解读

GaussDB Ustore存储引擎解读 GaussDB是华为云推出的一款高性能数据库产品,其内核新增的Ustore存储引擎为企业级用户提供了更高性能的数据库服务。Ustore存储引擎,又名In-place Update存储引擎(原地更新),是GaussDB内核…