根据 commit message 自动生成 changelog

本文介绍如何通过规范化的commit message自动生成CHANGELOG.md文件。利用conventional-changelog工具,配合commitlint及Husky实现git commit消息规范化,进而简化版本发布流程。文中详细解释了依赖安装、脚本配置及生成过程。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

前面和大家介绍了commitlint + Husky 规范 git commit 日志,提及了规范的 commit message 有助于团队其它人员 review,还可以有效的输出 CHANGELOG,本文就是介绍如何输出 CHANGELOG.md

  1. 安装依赖
npm install conventional-changelog conventional-changelog-cli --save-dev

or

yarn add conventional-changelog conventional-changelog-cli --save-dev
  1. 添加脚本

修改 package.json 中 scripts 字段

{
  "scripts": {
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0"
  }
}
  1. 生成CHANGELOG.md文件

直接运行下面的命令即可

npm run changelog

在这里插入图片描述

如果typefeatfixperfrevert,则该 commit 将肯定出现在 Change log 之中。其他情况(docschorestylerefactortest)由你决定,要不要放入 Change log,建议是不要。

注意,版本的log使用 npm version <newversion> 才会生成新的log,手动修改 package.json version 不会有新的版本log

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

__畫戟__

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值