Vuex 4源码学习笔记 - 做好changelog更新日志很重要(十)
在上一篇笔记中:Vuex是如何发布的(九)
我们看到了Vuex是通过npm run release
命令来运行release.js
这个发布脚本来进行发布,在其中有一个步骤是通过yarn changelog
命令来生成CHANGELOG.md文件,也就是每个版本都有哪些东西进行了变更。
那么它是怎么做到的呢?
老规矩,还是从package.json看起,我们可以找到一个changelog的命令
"scripts": {//..."changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",//...
}
他是通过conventional-changelog-cli
这个npm包来实现的自动生成CHANGELOG.md
。
它的使用也特别的简单:
$ npm install -g conventional-changelog-cli
$ cd my-project
$ conventional-changelog -p angular -i CHANGELOG.md -s
它的原理就是通过我们Git提交的信息,来去生成CHANGELOG.md
一般我们在项目中使用它的流程为:
- 开发功能,写代码
- 使用Git Commit来提交代码
- 执行测试代码,确保测试通过
- 升级package.json中的版本号
- 运行conventional-changelog来生成CHANGELOG.md文件
- 使用Git Commit来提交
package.json
和CHANGELOG.md
文件 - 打上Git Tag
- Git Push
那为什么一定要要生成CHANGELOG
呢?
在我们所有使用的开源软件中或者商业软件中,都会看到什么时候发布了什么版本更新了什么内容,那这个东西就是CHANGELOG,也叫做更新日志,所以一般我们会将更新日志作为发布周期的一部分进行自动化。
比如说:
Node.js现在最新版本是17
那我们就可以通过它的Changelog来查看Node.js的17版本有哪些功能:
我们可以点击它的每个功能的Commit来查看此次功能都有哪些代码的变更和功能说明
功能详细说明:
部分代码变更:
那么通过conventional-changelog
可以让我们通过Git信息来自动生成更加易于理解的更新日志。
感谢大家的阅读
一起学习更多前端知识,微信搜索【小帅的编程笔记】,每天更新
Vuex 4源码学习笔记 - 做好changelog更新日志很重要(十)相关推荐
- Vuex 4源码学习笔记 - 通过Vuex源码学习E2E测试(十一)
在上一篇笔记中:Vuex 4源码学习笔记 - 做好changelog更新日志很重要(十) 我们学到了通过conventional-changelog来生成项目的Changelog更新日志,通过更新日志 ...
- Vuex 4源码学习笔记 - 通过dispatch一步步来掌握Vuex整个数据流(五)
在上一篇笔记中:Vuex 4源码学习笔记 - Store 构造函数都干了什么(四) 我们通过查看Store 构造函数的源代码可以看到主要做了三件事情: 初始化一些内部变量以外 执行installMod ...
- Vuex 4源码学习笔记 - Vuex是怎么与Vue结合?(三)
在上一篇笔记中:Vuex源码学习笔记 - Vuex开发运行流程(二) 我们通过运行npm run dev命令来启动webpack,来开发Vuex,并在Vuex的createStore函数中添加了第一个 ...
- Java多线程之JUC包:Semaphore源码学习笔记
若有不正之处请多多谅解,并欢迎批评指正. 请尊重作者劳动成果,转载请标明原文链接: http://www.cnblogs.com/go2sea/p/5625536.html Semaphore是JUC ...
- RocketMQ 源码学习笔记 Producer 是怎么将消息发送至 Broker 的?
RocketMQ 源码学习笔记 Producer 是怎么将消息发送至 Broker 的? 文章目录 RocketMQ 源码学习笔记 Producer 是怎么将消息发送至 Broker 的? 前言 项目 ...
- jquery源码学习笔记三:jQuery工厂剖析
jquery源码学习笔记二:jQuery工厂 jquery源码学习笔记一:总体结构 上两篇说过,query的核心是一个jQuery工厂.其代码如下 function( window, noGlobal ...
- 雷神FFMpeg源码学习笔记
雷神FFMpeg源码学习笔记 文章目录 雷神FFMpeg源码学习笔记 读取编码并依据编码初始化内容结构 每一帧的视频解码处理 读取编码并依据编码初始化内容结构 在开始编解码视频的时候首先第一步需要注册 ...
- Apache log4j-1.2.17源码学习笔记
(1)Apache log4j-1.2.17源码学习笔记 http://blog.csdn.net/zilong_zilong/article/details/78715500 (2)Apache l ...
- PHP Yac cache 源码学习笔记
YAC 源码学习笔记 本文地址 http://blog.csdn.net/fanhengguang_php/article/details/54863955 config.m4 检测系统共享内存支持情 ...
最新文章
- 给出a的定义 -- 指针 和 数组
- 如何真正理解用户标签体系?
- 图片识别不了小程序怎么办_图片转文字【微信小程序】
- 前端学习(2747):uniapp环境搭建
- 爬虫 动态生成useragent的功能 fake-useragent库
- 我们不生产代码,我们只是代码的搬运工
- C++_函数_函数的占位参数_函数重载---C++语言工作笔记034
- python 编辑距离 2组匹配_Python文本相似性计算之编辑距离详解
- lua upvalue
- css阿拉伯数字,css 古文排版(含阿拉伯数字)
- 复旦大学《高等代数学(第三版)》教材勘误表
- DSP6678使用NDK网口通信
- 自建cdn搭建_在自己的服务器上搭建CDN加速服务的教程
- 2分钟入侵网站全程实录
- 毕业设计So Easy:基于Java语言西餐厅点餐系统
- 2004年南京美食地图 [转载]
- win10忘记密码_Win10系统设置u盘密码的操作过程
- Microsoft Toolkit(win8.1激活工具)v2.5.2 绿色版
- dzzoffice应用如何安装
- Linux下发送邮件