还在用git commit -m 吗？Git 提交规范和自动产生changelog手摸手教程。

最新推荐文章于 2024-04-08 20:39:33 发布
最新推荐文章于 2024-04-08 20:39:33 发布
阅读量750 收藏 13
点赞数 16
分类专栏： 2024年程序员学习 文章标签： git
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_60721907/article/details/136973854
版权

“devDependencies”: {

“cz-conventional-changelog”: “3.3.0”

},

“config”: {

“commitizen”: {

“path”: “./node_modules/cz-conventional-changelog”

}

}

}

3、修改代码提交过程介绍

这时候就可以提交尝试下，提交的时候直接执行刚才添加的脚本：

yarn commit 或者 npm run commit

执行完之后完看到这样的画面就对了：

在这里插入图片描述

下面介绍每步意思

第一步： 选择这次提交的内容类型

提交类型是以后生成CHANGELOG分类题目

在这里插入图片描述

| 类型 | 说明 |

| — | — |

| feat | feature 新功能 |

| fix | 修复bug |

| docs | 只是文档相关的修复 |

| style | 格式（不影响代码运行的变动） |

| refactor | 重构代码改变，既不是新功能，又不是修复bug |

| perf | 代码改变为了性能提升 |

| test | 新增测试或者修正测试 |

| build | 影响编译生成的变动，例如npm |

| ci | 持续集成工具集成变动 |

| chore | 其他变动不影响src或者test 文件 |

| revert | 回滚到之前的提交 |

按需选择一个类型，进入下一步，我这里选个新功能feat。

第二步： 这次提交影响范围

? What is the scope of this change (e.g. component or file name): (press enter to ski

p)

提交影响范围，例如一个组件，或者影响到的文件，比如我修改了Index.js文件，如实填写。

在这里插入图片描述

第三步：简短描述

这个简短描述，如果你使用gitlab 或者github 进行远程分支Merge requset 的时候，这个就是默认的title。

在这里插入图片描述

这里如实填写新增入口文件：

在这里插入图片描述

第四步：详细描述

同理合并的时候对应这一块：

在这里插入图片描述

填写如下内容：

在这里插入图片描述

第五步：是否重大更新（改变）

一般具有重要的大版本或者破坏原来代码的时候需要标记一下。

这个选择y/n 即可。

在这里插入图片描述

第六步：这次提交对哪些打开的issue 有影响

类似于github 开源模式，代码的维护不论需求还是fix都有对应的issue 讨论进行code的支撑。

git message 这一步就是为了关联issue。如果选择是，可写上相关issue 对应号码。

总体提交记录

在这里插入图片描述

三、 自动产生CHANGELOG

那么正规的写提交记录最后就是为了让团队其他人看懂，还有一个目的是为了更规范的产生CHANGELOG，下面看看自动产生CHANGELOG的步骤。

1、安装conventional-changelog-cli 插件

小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数初中级前端工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！
因此收集整理了一份《2024年Web前端开发全套学习资料》送给大家，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

img
img
img
img

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频

如果你觉得这些内容对你有帮助，可以添加下面V无偿领取！（备注：前端）
img

Vue 面试题

1.Vue 双向绑定原理
2.描述下 vue 从初始化页面–修改数据–刷新页面 UI 的过程？
3.你是如何理解 Vue 的响应式系统的?
4.虚拟 DOM 实现原理
5.既然 Vue 通过数据劫持可以精准探测数据变化,为什么还需要虚拟 DOM 进行 diff 检测差异?
6.Vue 中 key 值的作用？
7.Vue 的生命周期
8.Vue 组件间通信有哪些方式?
9.watch、methods 和 computed 的区别?
10.vue 中怎么重置 data?
11.组件中写 name 选项有什么作用？
12.vue-router 有哪些钩子函数?
13.route 和 router 的区别是什么？
14.说一下 Vue 和 React 的认识，做一个简单的对比
15.Vue 的 nextTick 的原理是什么？
16.Vuex 有哪几种属性?
17.vue 首屏加载优化
18.Vue 3.0 有没有过了解？
19.vue-cli 替我们做了哪些工作？

name 选项有什么作用？
12.vue-router 有哪些钩子函数?
13.route 和 router 的区别是什么？
14.说一下 Vue 和 React 的认识，做一个简单的对比
15.Vue 的 nextTick 的原理是什么？
16.Vuex 有哪几种属性?
17.vue 首屏加载优化
18.Vue 3.0 有没有过了解？
19.vue-cli 替我们做了哪些工作？
[外链图片转存中…(img-V0Opp2nc-1711194451345)]

开源分享：【大厂前端面试题解析+核心总结学习笔记+真实项目实战+最新讲解视频】

不讲伍德老开发
关注
  • 16
    点赞
  • 踩
  • 13
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
git-commit-lint-vscode:vscode一款git 规范化提交插件
05-17
在日常的开发中,目前主流的代码管理工具就是 git 了,当我们对代码进行改动了,首先得git commit提交到本地仓库,git 规定了提交时必须填写提交信息作为改动说明,保存 commit 历史中,可以找到历史代码,也方便他人 ...
git工程化 自动生成changeLog 发布版本
qq_35425070的博客
06-21 7253
git log 生成 changeLog 在进行git仓库的自动化管理时，发布前往往需要CI服务器自动生成 CHANGELOG.MD ，本文介绍如何自动changeLog.md自动生成的思路。 生成流程 多次 commit -m “xxx” 使用命令 git log > log 生成提交记录 log 文件 处理 log 文件提取关心的信息, 然后转成 CHANGELOG.MD 文件. 思路：（log文件中包含了所有的commit信息, 包括id, author, date以及comment等） 前
Git做版本管理及CHANGELOG
这魏先森-forguo
09-02 956
规范化的提交信息除了能很好描述项目的修改，还有一个很好的作用就是能根据提交记录来生成CHANGELOG.MD和自动生成版本号等功能。
git commit规范 、CHANGELOG生成 和版本发布的标准自动化
wyhbest的博客
02-05 3671
一站式解决 git commit、自动生成 CHANGELOG、版本发布的标准自动化工具三个方面问题
自动生成 changelog.md，做一名有追求的工程师
知之为知之，不知为不知
04-22 4257
commitlint + Husky 规范 git commit 日志；根据 commit message 自动生成 changelog；自定义changelog；commitlint 规范；
前端小纠结--约定式提交和自动生成changelog
weixin_34326179的博客
05-21 3090
原文链接 约定式提交 约定式提交：每次使用git commit 的时候都需要写commit message,如果message style是按照固定的模版格式书写，对于后期的维护和编写changelog都有巨大的好处。 而且现在的很多自动生成changelog的工具，都是建立在约定式提交的基础之上。 约定式提交校验配置 约定式提交不需要任何的配置，只需要严格遵守其规范就可以了。 为了保证...
git-commit-style-guide：使git commit消息更易读和有用
02-03
统一团队的Git工作流，包括分支使用，标签规范，问题等Git commit日志参考案例总体方案Git提交日志基本规范(): <subject><BLANK><body><BLANK><footer>所有的类型类型如下： 类型代表某人次提交的类型，某种是...
git-conventional-commits:Git Conventional提交实用程序以生成语义版本和Markdown更改日志并验证提交消息
04-30
Git常规承诺 :information: 看看 安装 npm install --global git-conventional-commits 用法 创建git-conventional-commits init 根据您的需要调整config git-conventional-commits.json ... changelog [options]
bump-version:完整的[git commit＆lint]→[changelog]→[release]工作流程和约定
04-30
完整的git commit > changelog > release工作流程和约定。 现在仅适用于Node.js项目。 感谢的灵感。 安装 npm install -D @picgo/bump-version # or yarn add -D @picgo/bump-version 另外，在package.json的顶层...
simple-commit-message:简单的提交消息向导和验证器； 与 commitizen 和 pre-git 一起使用
07-23
与 commitizen 和 pre-git 一起使用 目的 该模块可以： 解析类型type(scope): message简单提交消息type(scope): message 验证给定消息是否符合上述简单格式 引导用户提问，以形成格式良好的消息 有效的提交消息 ...
git-tag-changelog:使用git标签注释创建更改日志
05-27
git-tag-changelog 创建更改日志，并将其保存在git标签注释中 此命令行工具依赖于存储库中现有的标记之类的事实标准。 即v1.0.0，v1.5.0，v2.0.0等。 它使用这些标记来确定提交，找到标记之间的增量提交，并基于这些增量提交来生成变更日志。 假设您使用的是传统提交，则changelog实际上只是使用提交消息的前缀字符串对提交消息进行的分组。 更改日志以markdown格式生成，然后保存到git标记的注释中。 您可以将这些标签推送到原始位置，如果使用的是Github，它将自动显示在存储库的“发行版”部分中。 请注意，该工具不会代替传统的提交工具或发布工具，它只会抓取您的提交消息，并创建一个“ changelog”，然后将其附加到您回购中的现有标签上。 入门 使用以下命令安装模块： npm install git-tag-changelog 用法 安装此模块会
git-changelog:来自git消息的分类更改日志
05-19
git-changelog是用于生成通常在项目发行里程碑中分发的（又称为发行说明）的工具。 与其他执行相同操作的工具不同，该工具不需要您遵循任何特定的git工作流程约定。 它所假设的只是您将选择一些关键字（或使用内置关键字）来注释提交消息中的行。 具体而言，一个提交产生输出。 当您希望记录用户可见的更改（例如，新功能，错误修复，重大更改等）时，您可以编写一条普通的提交消息，并用所选的关键字在其中注释一些行。 带注释的行在报表生成时用于将更改组织成类别和范围。 然后，将有组织的更改呈现为漂亮而准确的更改日志。 没有标签的提交消息将被悄悄地忽略，您可以随意添加任意数量的标签。 这是一个快速演示： 动机 提交消息必须始终有意义，并且只需付出一点额外的努力，我们就可以自动完成为用户生成有意义的更改日志的工作。 当我完成变更工作时，我想暂停一下，考虑一下变更对最终用户意味着什么，并稍微重新组织
gitchangelog, 从git日志历史记录创建日志记录.zip
09-18
gitchangelog, 从git日志历史记录创建日志记录 gitchangelog 使用提交日志来创建beautifull和可以配置日志文件文件。特性完全由一个配置文件驱动，可以用你的变更日志策略进行定制。 ( 参见参考配置文件 )根据正则表达式匹配筛选出提交/标
Git 规范和 Changelog 生成
liixnhai的博客
08-17 2292
1、良好的 Git commit 规范优势： ·加快 Code Review 的流程 ·根据 Git Commit 的元数据生成 Changelog ·后续维护者可以知道 Feature 被修改的原因 2、提交时类型选择提示，commitize 不符合格式的日志拒绝提交的保障机制，validate-commit-msg工具+客户端、 gitlab serverhook做统一changelog 文档信息生成，使用conventional-changelog-cli工具 3、angular的g
Linux下使用git-cliff生产CHANGELOG.md
xupeng1644的博客
10-16 934
git-cliff 是一个高度可定制的更新日志生成器，遵循常规的 Commit 规范。git-cliff 可以通过利用传统的 commits 以及由 regex 驱动的自定义解析器，从 Git 历史中生成更新日志文件。更新日志模板可以用配置文件定制，以符合所需的格式。
还在用git commit -m 吗？Git 提交规范和自动产生changelog手摸手教程
最新发布
2401_83974473的博客
04-08 854
或者执行完之后完看到这样的画面就对了：下面介绍每步意思面试前要精心做好准备，简历上写的知识点和原理都需要准备好，项目上多想想难点和亮点，这是面试时能和别人不一样的地方。还有就是表现出自己的谦虚好学，以及对于未来持续进阶的规划，企业招人更偏爱稳定的人。万事开头难，但是程序员这一条路坚持几年后发展空间还是非常大的，一切重在坚持。为了帮助大家更好更高效的准备面试，特别整理了《前端工程师面试手册》电子稿文件。前端面试题汇总JavaScript性能linux前端资料汇总。
vue 根据git commit记录生成CHANGELOG.md文档
好巧的博客
10-20 1283
当然，如果你觉得文章有什么让你觉得不合理、或者有更简单的实现方法又或者有理解不来的地方，希望你在看到之后能够在评论里指出来，我会在看到之后尽快的回复你。生成 CHANGELOG.md 需要符合 git commit 提交规范，规范配置请查看另一篇文章。-n ./.changelog.config.js: 自定义配置文件。1.根目录新建 .changelog.config.js。-i CHANGELOG.md：指定输出的文件名称。-r 0：指定增量更新，不会覆盖以前的更新。-s：指定读写同一文件。
git commit -m和git commit 区别
05-31
`git commit -m` 和 `git commit` 的区别在于提交代码时是否添加提交信息。 `git commit -m` 命令用于将暂存区的修改提交到 Git 代码库中，并且可以添加一条提交信息，描述本次提交的内容。选项 `-m` 后跟着的字符串就是提交信息的内容。例如： ``` $ git add . $ git commit -m "add a new feature" ``` 这个命令将当前目录下所有修改添加到暂存区，然后提交暂存区的修改到 Git 代码库中，并添加了一条提交信息，描述本次提交的内容为“add a new feature”。 而 `git commit` 命令则会打开默认编辑器，供用户输入提交信息。例如： ``` $ git add . $ git commit ``` 这个命令将当前目录下所有修改添加到暂存区，然后打开默认编辑器，供用户输入提交信息。 因此，`git commit -m` 更适用于提交简短的修改，而 `git commit` 更适用于需要添加详细提交信息的情况。不过，无论使用哪种方式提交代码，都应该添加有意义的提交信息，以便自己和其他开发者能够快速了解本次提交的内容。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值