在上一篇笔记中: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

一般我们在项目中使用它的流程为:

  1. 开发功能,写代码
  2. 使用Git Commit来提交代码
  3. 执行测试代码,确保测试通过
  4. 升级package.json中的版本号
  5. 运行conventional-changelog来生成CHANGELOG.md文件
  6. 使用Git Commit来提交package.jsonCHANGELOG.md 文件
  7. 打上Git Tag
  8. Git Push

那为什么一定要要生成CHANGELOG呢?

在我们所有使用的开源软件中或者商业软件中,都会看到什么时候发布了什么版本更新了什么内容,那这个东西就是CHANGELOG,也叫做更新日志,所以一般我们会将更新日志作为发布周期的一部分进行自动化。

比如说:

Node.js现在最新版本是17

那我们就可以通过它的Changelog来查看Node.js的17版本有哪些功能:

我们可以点击它的每个功能的Commit来查看此次功能都有哪些代码的变更和功能说明

功能详细说明:

部分代码变更:

那么通过conventional-changelog可以让我们通过Git信息来自动生成更加易于理解的更新日志。

感谢大家的阅读

一起学习更多前端知识,微信搜索【小帅的编程笔记】,每天更新

Vuex 4源码学习笔记 - 做好changelog更新日志很重要(十)相关推荐

  1. Vuex 4源码学习笔记 - 通过Vuex源码学习E2E测试(十一)

    在上一篇笔记中:Vuex 4源码学习笔记 - 做好changelog更新日志很重要(十) 我们学到了通过conventional-changelog来生成项目的Changelog更新日志,通过更新日志 ...

  2. Vuex 4源码学习笔记 - 通过dispatch一步步来掌握Vuex整个数据流(五)

    在上一篇笔记中:Vuex 4源码学习笔记 - Store 构造函数都干了什么(四) 我们通过查看Store 构造函数的源代码可以看到主要做了三件事情: 初始化一些内部变量以外 执行installMod ...

  3. Vuex 4源码学习笔记 - Vuex是怎么与Vue结合?(三)

    在上一篇笔记中:Vuex源码学习笔记 - Vuex开发运行流程(二) 我们通过运行npm run dev命令来启动webpack,来开发Vuex,并在Vuex的createStore函数中添加了第一个 ...

  4. Java多线程之JUC包:Semaphore源码学习笔记

    若有不正之处请多多谅解,并欢迎批评指正. 请尊重作者劳动成果,转载请标明原文链接: http://www.cnblogs.com/go2sea/p/5625536.html Semaphore是JUC ...

  5. RocketMQ 源码学习笔记 Producer 是怎么将消息发送至 Broker 的?

    RocketMQ 源码学习笔记 Producer 是怎么将消息发送至 Broker 的? 文章目录 RocketMQ 源码学习笔记 Producer 是怎么将消息发送至 Broker 的? 前言 项目 ...

  6. jquery源码学习笔记三:jQuery工厂剖析

    jquery源码学习笔记二:jQuery工厂 jquery源码学习笔记一:总体结构 上两篇说过,query的核心是一个jQuery工厂.其代码如下 function( window, noGlobal ...

  7. 雷神FFMpeg源码学习笔记

    雷神FFMpeg源码学习笔记 文章目录 雷神FFMpeg源码学习笔记 读取编码并依据编码初始化内容结构 每一帧的视频解码处理 读取编码并依据编码初始化内容结构 在开始编解码视频的时候首先第一步需要注册 ...

  8. Apache log4j-1.2.17源码学习笔记

    (1)Apache log4j-1.2.17源码学习笔记 http://blog.csdn.net/zilong_zilong/article/details/78715500 (2)Apache l ...

  9. PHP Yac cache 源码学习笔记

    YAC 源码学习笔记 本文地址 http://blog.csdn.net/fanhengguang_php/article/details/54863955 config.m4 检测系统共享内存支持情 ...

最新文章

  1. 给出a的定义 -- 指针 和 数组
  2. 如何真正理解用户标签体系?
  3. 图片识别不了小程序怎么办_图片转文字【微信小程序】
  4. 前端学习(2747):uniapp环境搭建
  5. 爬虫 动态生成useragent的功能 fake-useragent库
  6. 我们不生产代码,我们只是代码的搬运工
  7. C++_函数_函数的占位参数_函数重载---C++语言工作笔记034
  8. python 编辑距离 2组匹配_Python文本相似性计算之编辑距离详解
  9. lua upvalue
  10. css阿拉伯数字,css 古文排版(含阿拉伯数字)
  11. 复旦大学《高等代数学(第三版)》教材勘误表
  12. DSP6678使用NDK网口通信
  13. 自建cdn搭建_在自己的服务器上搭建CDN加速服务的教程
  14. 2分钟入侵网站全程实录
  15. 毕业设计So Easy:基于Java语言西餐厅点餐系统
  16. 2004年南京美食地图 [转载]
  17. win10忘记密码_Win10系统设置u盘密码的操作过程
  18. Microsoft Toolkit(win8.1激活工具)v2.5.2 绿色版
  19. dzzoffice应用如何安装
  20. Linux下发送邮件

热门文章

  1. 从“金融IT”乙方转到甲方的职场感悟
  2. 枚举类型的理解和应用
  3. 数据处理之标准化/归一化方法
  4. Hander异步消息处理机制完全解析
  5. CogCreateSegmentTool工具
  6. [HTML]入门小知识,列表?框架?表格?来吧。纯手工制作,满满都是智慧
  7. 设置img标签的默认图片
  8. mysql查询出现毫秒值快速解决方法
  9. 哈工大刘挺:自然语言处理中的可解释性问题!
  10. java计算机毕业设计东理咨询交流论坛源码+系统+lw文档+mysql数据库+部署