Gitlab学习之企业常用的一些git规范
俗话说，没有规则不可周遭，我们的git也需要规范 。
下面先容一下企业常用的一些规范 。
分支治理规范
分支命名不可千奇百怪，必需有统一的命名方法 。主要有以下几种：
| 分支治理 | 命名规范 | 诠释 |
|---|---|---|
| master 主分支 | master | 稳固版天职支，上线完成回归后后，由项目手艺认真人从 release 分支合并进来，并打 tag |
| test 测试分支 | test/yyyyMMdd_ 功效名称示例：test/20220426_blog | 测试职员使用分支，测试时从 feature 分支合并进来 |
| feature 功效开发分支 | feature/yyyyMMdd_ 功效名称_认真职员示例：feature/20220426_blog_xiumubai | 新功效开发使用分支，基于master建设 |
| fix bug修复分支 | fix/yyyyMMdd_ 功效名称_认真职员示例：fix/20220426_blog_xiumubai | 紧迫线上bug修复使用分支，基于master建设 |
| release 上线分支 | release/版本号示例：release/0.1.0 | 用于上线的分支，基于 master 建设，必需对要并入的 feature 分支举行 Code review 后，才可并入上线 |
版本号治理规范
当我们上线的时间，需要给版本号打tag，下面是版本号规范：
项目上线release分支建设界说： 第一个数字是主版本 。第二个数字是次版本 。第三个数字是补丁版本(hotfix 类的更新) 。 主版本：含有破损性更新、大调解等 。 例如：1.1.0 > 2.0.0 次版本：增添新功效特征 。例如：1.1.0 > 1.2.0 补丁版本：修复问题等 。例如：1.1.0 > 1.1.1
登录后复制
下图是一个围绕git规范来的开发流程图：
提交信息规范
最后是commit的时间，需要对commit信息规范，必需要加前缀
| 前缀 | 诠释 |
|---|---|
| feat | 新功效 |
| fix | 修复 |
| docs | 文档变换 |
| style | 代码名堂 |
| refactor | 重构 |
| perf | 性能优化 |
| test | 增添测试 |
| revert | 回退 |
| build | 打包 |
| chore | 构建历程或辅助工具的变换 |
下图是vue3源码的提交信息规范：
下面我们就现实操作一下，若是通过husky+commitlint集成一个统一规范的git commit信息 。
设置 git 提交的校验钩子
husky: git提交时触发hooks
commitlint: 对提交的内容做规范校验 husky，主要对pre-commit和commit-msg钩子做校验 。
# 装置husky yarn add husky -D # 初始化husky设置，在根目录新增.husky设置文件 。初始化设置pre-commit npx husky-init # 另外新增一个hooks，commit-msg npx husky add .husky/commit-msg
登录后复制
目录结构是下面这样子的：
在commit-msg文件中添加 npm run commitlint
在pre-commit文件中有个npm run test我们先注释掉，不然会报错 。
装置commitlint
# 添加依赖文件 yarn add @commitlint/config-conventional @commitlint/cli -D
登录后复制
添加设置文件，新建commitlint.config.js，然后添加下面的代码：
module.exports = {
extends: ['@commitlint/config-conventional'],
// 校验规则
rules: {
'type-enum': [
2,
'always',
[
'feat',
'fix',
'docs',
'style',
'refactor',
'perf',
'test',
'chore',
'revert',
'build',
],
],
'type-case': [0],
'type-empty': [0],
'scope-empty': [0],
'scope-case': [0],
'subject-full-stop': [0, 'never'],
'subject-case': [0, 'never'],
'header-max-length': [0, 'always', 72],
},
}
登录后复制
设置scripts
由于我们需要运行npm run commitlint，以是需要在package.json文件中添加如下代码：
# 在scrips中添加下面的代码
{
"scripts": {
"commitlint": "commitlint --config commitlint.config.js -e -V"
},
}
登录后复制
设置竣事，现在当我们填写commit信息的时间，前面就需要带着下面的subject
'feat', 'fix', 'docs', 'style', 'refactor', 'perf', 'test', 'chore', 'revert', 'build',
登录后复制
好比：git commit -m “feat: test”,注重feat:后面有个空格
我们来写一个过失的来测试一下：
提醒subject是空的 。
使用准确的提交方法，提交乐成了
使用 commitizen 做git规范化提交
由于添加了commitlint验证，关于不熟悉提交规范的新手同砚会有一定影响，可以添加 commitizen 工具，手动生陋习范化commit 。
Commitizen是一个名堂化commit message的工具 。
# 工具装置 yarn add -D commitizen
登录后复制
使用cz-conventional-changelog
装置工具
yarn add cz-conventional-changelog -D
登录后复制
设置下令
"script": {
"commit": "cz"
}
登录后复制
在package.json 中添加界说commitizen使用规则，
{
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
},
}
登录后复制
当执行git commit的时间，就可以提醒我们填写代码规则了
自界说 commitizen 规则
使用 cz-customizable 工具
# 装置依赖 yarn add cz-customizable -D
登录后复制
设置下令
"script": {
"commit": "git-cz"
}
登录后复制
在package.json 中添加自界说commitizen，使用git-cz执行git commit下令
"config": {
"commitizen": {
"path": "./node_modules/cz-customizable"
}
}
登录后复制
在根目录建设的.cz-config.js, 自界说commit提醒内容
module.exports = {
types: [
{ value: 'feat', name: 'feat: 新功效' },
{ value: 'fix', name: '?fix: 修复' },
{ value: 'docs', name: '️docs: 文档变换' },
{ value: 'style', name: '?style: 代码名堂(不影响代码运行的变换)' },
{
value: 'refactor',
name: '️refactor: 重构(既不是增添feature，也不是修复bug)'
},
{ value: 'perf', name: '️perf: 性能优化' },
{ value: 'test', name: 'test: 增添测试' },
{ value: 'chore', name: '?chore: 构建历程或辅助工具的变换' },
{ value: 'revert', name: '⏪️revert: 回退' },
{ value: 'build', name: '?️build: 打包' },
{ value: 'ci', name: '?CI: related changes' }
],
// override the messages, defaults are as follows
messages: {
type: '请选择提交类型(必选):',
// scope: '请输入文件修改规模(可选):',
customScope: '请输入修改规模(可选):',
subject: '请简要形貌提交(必填):',
// body: '请输入详细形貌(可选，待优化去除，跳过即可):',
// breaking: 'List any BREAKING CHANGES (optional):n',
footer: '请输入要关闭的issue(待优化去除，跳过即可):',
confirmCommit: '确认使用以上信息提交 ？(y/n/e/h)'
},
// used if allowCustomScopes is true
allowCustomScopes: true,
// allowBreakingChanges: ['feat', 'fix'],
skipQuestions: ['body', 'footer'],
// limit subject length, commitlint默认是72
subjectLimit: 72
}
登录后复制
当我们提交接码的时间，需要先git add .，然后执行npm run commit,就可以凭证响应的提醒填写commit信息 了，如下图所示：
（学习视频分享：编程基础视频）
以上就是Gitlab学习之企业常用的一些git规范的详细内容，更多请关注本网内其它相关文章！
