Git commit提交规范与`Changelog`生成

最新推荐文章于 2024-05-17 10:13:07 发布
最新推荐文章于 2024-05-17 10:13:07 发布
阅读量1.8k 收藏
点赞数 2
分类专栏： Git
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43550660/article/details/105459038
版权

Git commit规范与Changelog生成

良好的Git commit 规范优势

  • 加快Code Review的流程
  • 根据Git Commit的元数据生成Changelog
  • 后续维护者可以知道Feature被修改的原因
技术方案：

统一团队Git commit日志标准，便于后续代码review和版本发布

使用Git commit日志作为基本规范

  • 提交类型限制为:feat,fix,docs,style,rrefactor,perf,test,chore,revert等
  • 提交信息分为俩部分，标题（首字母不大写，末尾不i要标点）、主题内容（正常的描述信息即可）

日志提交时友好的类型选择提示

  • 使用commitize工具

不符合要求格式的日志拒绝提交的保障机制

  • 使用validata-commit-msg工具
  • 需要同时在客户端、gitlab serverhook做

统一Changelog文档信息生成

  • 使用conventional-changelog-cli工具
提交格式要求
<type>(<scope>):<subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

对格式的说明如下：

  • type:代表某次提交的类型，比如时修复一个bug还是增加一个新的feature

  • feat：新功能（feature）

  • fix：修补bug

  • docs：文档（documentation）

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

  • refactor：重构（即不是新增功能，也不是修改bug的代码变动）

  • test：增加测试

  • chore：构建过程或辅助工具的变动

  • revert:回滚到上一个版本

本地开发阶段增加precommit钩子

npm i husky --save-dev
通过commitmsg钩子校验信息
"scripts":{
	"commitmsg":"validata-commit-msg",
	"changelog":"conventional-changelog -p angular -i CHANGELOG.md -s -r 0"
},
"devDependencies":{
	"validata-commit-msg":"^2.11.1",
	"conventional-changelog-cli":"^1.2.0",
	"husky":"^0.13.1"
}
开源项目版本信息案例

软件的版本通常由三位组成，形如：X.Y.Z

版本时严格递增的，例如：16.2.0==>12.3.0==>12.3.1

在发布重要版本时，可以发布alpha,rc等先行版本

遵守semver规范的优势

优势：

  • 避免出现循环依赖
  • 依赖冲突减少
语义化版本（Semantic Versioning） 规范格式

主版本号：当你做了不兼容的API修改 ==》 X

次版本号：当你做了向下兼容的功能性新增==》Y

修订号：当你做了向下兼容的问题修正==》Z

先行版本号
  • alpha:内部测试版
  • beta：测试版
  • rc：发行候选版本
秃如其来的秃头
关注
  • 2
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
git工程化 自动生成changeLog 发布版本
qq_35425070的博客
06-21 7325
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 commit -m 吗？Git 提交规范和自动产生changelog手摸手教程。
星宇大前端
01-12 1436
前言 我们在使用一个比较厉害的框架或者库的时候，经常可以看到CHANGELOG.md，维护版本更新内容。 比如vue-next： 这种版本更新内容是非常必要的，如果用户使用了你的轮子，连更新内容都不知道，试问你敢用吗？ 那么这些都是怎么写的呢？每次发版都要手动记录吗？显然不是，这些都是靠提条记录生成的。下面一起他探索一下吧。   正文 生成这种CHANGELOG 有一个前提，就是团队成员都按规矩提交。 人不是机器，习惯不养成往往会忽略，这种约束还是工具来吧。 一、安装 commitizen
超详细教程：使用GitLab自动发布程序并生成发布说明
最新发布
GitLab 中国发行版
05-17 1096
极狐GitLab 自动化发布使用教程。
webpack配置篇（三十七）：Git 规范和 Changelog 生成
学习前端这门手艺，栈底到栈顶依次是：浏览器架构、Web 网络、事件循环机制、JavaScript 核心、V8 的内存管理、浏览器的渲染流程、Web 安全、CSS、React、Vue、Node、构建工具链等
08-15 305
说明 玩转webpack学习笔记 介绍 良好的 Git commit 规范优势： 加快 Code Review 的流程 根据 Git Commit 的元数据生成 Changelog 后续维护者可以知道 Feature 被修改的原因 技术方案 提交格式要求 本地开发阶段增加 precommit 钩子 安装 husky npm install husky --save-dev 通过 commitmsg 钩子校验信息 "scripts": { "commitmsg": "validate-commit
如何快速创建 git 的 changlog
_
01-19 1644
创建脚本 changelog-generate.sh , 内容如下 #!/bin/bash # Generates changelog day by day NEXT=$(date +"%Y.%m.%d") CHANGELOG=./CHANGELOG.md rm -rf $CHANGELOG echo $CHANGELOG echo "# CHANGELOG" >> $CHANGELOG echo "----------------------" >> $CHANGELOG g
gitlab展示CHANGELOG
你就像甜甜的益达
11-30 1762
有点项目有CHANGELOG有的没有, 没有的话,需要创建CHANGELOG.md文件,跟readme.md同一级,master分支,即可; 提交就有了…
git-commit-lint-vscode:vscode一款git 规范化提交插件
05-17
git 了,当我们对代码进行改动了,首先得git commit提交到本地仓库,git 规定了提交时必须填写提交信息作为改动说明,保存 commit 历史中,可以找到历史代码,也方便他人 review,还可以输出 CHANGELOG,对项目的研发质量都...
generate-changelog:从git commit生成变更日志
05-09
$ npm i generate-changelog -D # install it as a dev dependency # OR $ npm i generate-changelog -g # install it globally 用法 要使用此模块，您的提交消息必须采用以下格式： type(category): description ...
jira-changelog:通过将git commit与Jira票证相匹配来生成变更日志
04-30
$ jira-changelog --range origin/prod...origin/master Jira Tickets --------------------- * <Bug> - Unable to access date widget [DEV-1234] https://yoursite.atlassian.net/browse/DEV-1234 * <Story> -...
git-changelog:生成一个git changelog，CLI或grunt插件，灵感来自Angular JS changelog生成器
05-02
您可以使用以下提交属性： 提交主题提交主体提交链接提交哈希提交中断提交类型提交组件关闭：包含已关闭问题的字符串链接：链接到提交提交 V1.0.0 从版本1.0.0 git-changelog包含了.changelogrc规范，并中止了以下...
changelogx:来自git commit的另一个changelog生成器，基于约定并带有可选的钩子来强制执行规则
05-08
来自git commit的另一个changelog生成器，基于约定并带有可选的钩子来强制执行规则 安装 npm i -g changelogx 将这样的部分添加到package.json中： { "changelogx" : { // the text is passed to new RegExp with...
gitlab-changelog:一个通过gitlab api生成changelogPHP脚本
05-25
gitlab更改日志 一个通过gitlab api v3生成变更日志PHP脚本 用法 composer.json： { " require " : { " zenozeng/gitlab-changelog " : " 0.1.1 " } } index.php： <?php require "vendor/autoload.php" ; use GitlabChangelog \ GitlabChangelog ; $ changelog = new GitlabChangelog (); $ changelog -> url = "http://gitlab.alibaba-inc.com/" ; $ changelog -> repo = "ata/atatech-kb" ; $ changelog -> token = "YOUR PRIVA
gitlab-changelog-generator:基于Gitlab生成变更日志
05-18
gitlab-changelog-generator 根据Gitlab里程碑生成变更日志并合并请求 安装 $ npm install --saveDev gitlab-changelog-generator 然后使用以下参数执行它： 网址：gitlab网址 令牌：gitlab专用访问令牌 destFile：changelog生成的文件路径（相对路径） projectId：您的项目ID的编号或名称 例子 ： $ node gitlab-changelog-generator --url https://yourgitlab --token XXXX --projectId group/name --destFile changelog.md
git 撤销变更_Git入门指南—什么是变更日志以及如何生成变更日志
cumian9828的博客
08-16 976
git 撤销变更Say you are a developer, and you use Git for one of your projects. You want to share the changes you made with your users, but you don’t know how. Well, then this article is for you. 假设您是一名开发人...
git根据commit生成patch（转载）
weixin_30561425的博客
02-09 1216
转自：http://smilejay.com/2012/08/generate-a-patch-from-a-commit/ 在看一个Bugzilla上Xen的一个bug时，提到要revert掉Dom0（用linux.git）中一个commit，当然git是有revert命令的，如下所示。 [root@jay-linux linux.git]# git revert cd9db80e...
Git 规范和 Changelog 生成
liixnhai的博客
08-17 2307
1、良好的 Git commit 规范优势： ·加快 Code Review 的流程 ·根据 Git Commit 的元数据生成 Changelog ·后续维护者可以知道 Feature 被修改的原因 2、提交时类型选择提示，commitize 不符合格式的日志拒绝提交的保障机制，validate-commit-msg工具+客户端、 gitlab serverhook做统一changelog 文档信息生成，使用conventional-changelog-cli工具 3、angular的g
git 的release-notes以及对应的changelog管理
天行健，地势坤
07-08 5433
我们在github 或者gitlab上做项目管理的时候需要对 对应的项目做历史版本的管理，同时包括每个版本中所做的一些改动：feature,bugfix,improv。 如果我们能够有一个统一的自动化管理方式，那么对于我们后续的版本回顾就能提供巨大的便捷，同时能够提供每个commit对应的commit链接，那就更好了。 最终的版本管理CHANGELOG.md文件的效果如下： 同时在github对应的tags 处也能够看到一些release-notes的信息。 创建仓库 按照自己的方式或者根据github的
git使用总结（包含git commit message 和 changelog 工具的介绍）
weixin_30537451的博客
04-05 195
【git的配置】 1.配置用户名和邮箱: 分为全局配置和局部配置 --system 系统配置 --global 全局配置 --local 局部配置 Git读取时：优先从local>global>system git config --global user.name name git config --global user.email email ...
GitLab 简明维护指南（v2020.05）
为了不折腾而去折腾的那些事
05-05 790
本文使用「署名 4.0 国际 (CC BY 4.0)」许可协议，欢迎转载、或重新修改使用，但需要注明来源。 署名 4.0 国际 (CC BY 4.0) 本文作者: 苏洋 创建时间: 2020年05月05日 统计字数: 8304字 阅读时间: 17分钟阅读 本文链接: https://soulteary.com/2020/05/05/gitlab-concise-maintenance-guide-...
如何查看git 中的git commit 提交规范
07-28
回答: 要查看git中的git commit提交规范，可以执行以下命令: 1. 使用`git add .`将所有修改添加到暂存区。 2. 使用`git cz`或者`npm run commit`执行提交命令。 3. 如果想要限制提交内容按照规范来，可以使用commitlint。首先安装commitlint相关的依赖，可以执行`npm i -D commitlint @commitlint/config-conventional @commitlint/cli`。 4. 然后，commitlint会帮助我们限制git提交时的信息，如果提交的信息不符合指定的规范，会直接拒绝提交。 #### 引用[.reference_title] - *1* *2* *3* [Git Commit 提交规范](https://blog.csdn.net/win7583362/article/details/123176104)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^insertT0,239^v3^insert_chatgpt"}} ] [.reference_item] [ .reference_list ]

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值