admin管理员组文章数量:1590697
Angular规范
git commit信息规范化可以带来很多好处,例如review信息明确、版本回退时能准确定位需要回退的点、release时自动生成CHANGELOG等,Angular规范本身也简洁明了,在全世界范围内广泛使用,其主要内容如下:
分支命名
- master 分支
master 为主分支,也是用于部署生产环境的分支,确保master分支稳定性 master 分支一般由develop以及hotfix分支合并,任何时间都不能直接修改代码 - develop 分支
develop 为开发分支,始终保持最新完成以及bug修复后的代码, 一般开发的新功能时,feature分支都是基于develop分支下创建的 - feature 分支
开发新功能时,以develop为基础创建feature分支 分支命名: feature/ 开头的为特性分支, 命名规则:
feature/user_module、 feature/cart_module - release分支
release 为预上线分支,发布提测阶段,会release分支代码为基准提测
当有一组feature开发完成,首先会合并到develop分支,进入提测时会创建release分支。如果测试过程中若存在bug需要修复,则直接由开发者在release分支修复并提交。当测试完成之后,合并release分支到master和develop分支,此时master为最新代码,用作上线。 - hotfix 分支
分支命名: hotfix/ 开头的为修复分支,它的命名规则与 feature 分支类似 线上出现紧急问题时,需要及时修复,以master分支为基线,创建hotfix分支,修复完成后,需要合并到master分支和develop分支
Commit messages的基本语法
当前业界应用的比较广泛的是 Angular Git Commit Guidelines
具体格式为:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
type: 本次 commit 的类型,诸如 bugfix docs style 等
scope: 本次 commit 波及的范围
subject: 简明扼要的阐述下本次 commit 的主旨,在原文中特意强调了几点:使用祈使句,首字母不要大写,结尾无需添加标点
body: 同样使用祈使句,在主体内容中我们需要把本次 commit 详细的描述一下,比如此次变更的动机,如需换行,则使用 |
footer: 描述下与之关联的 issue 或 break change
Type的类别说明:
- feat: 添加新特性
- fix: 修复bug
- docs: 仅仅修改了文档
- style: 仅仅修改了空格、格式缩进、都好等等,不改变代码逻辑
- refactor: 代码重构,没有加新功能或者修复bug
- perf: 增加代码进行性能测试
- test: 增加测试用例
- chore: 改变构建流程、或者增加依赖库、工具等
具体细节参考以上链接就好,这里不多赘述。
Ubuntu 18.04环境配置与commitizen安装
commitizen可以用来自动生成Angular规范的commit语句,其安装流程如下:
安装nodejs和npm:
理论上可以直接使用:
sudo apt install nodejs
sudo apt install npm
安装,但本人实测会有报错:Depends: node-gyp (>= 0.10.9) but it is not going to be installed,npm无法使用,因此使用:
sudo apt install curl
curl -sL https://deb.nodesource/setup_10.x | sudo -E bash -
sudo apt-get install -y nodejs
以上10.x代表版本,也可以安装更新的版本,安装成功后安装commitizen:
sudo npm install -g commitizen
cd到你的仓库中:
cd your_project
npm init -y
上面的命令不能跳过,然后再在仓库中运行下面的命令,
sudo commitizen init cz-conventional-changelog --save-dev --save-exact
如果你用yarn,也可以用下面的命令
sudo commitizen init cz-conventional-changelog --yarn --dev --exact
上面的命令为你做了三件事
(1)安装cz-conventional-changelog适配npm module;
(2)将cz-conventional-changelog保存在了package.json的dependencies或者devDependencies中;
(3)在package.json中添加了一个配置,如下:
图中的配置主要是为了告诉Commitizen当开发者向仓库提交代码时使用哪一个适配器。
commitizen.path主要通过require.resolve解析路径,它支持以下几种路径写法,
(1)npm包;
(2)包含index.js文件的文件夹,文件夹路径相对命令执行目录;
(3)js文件,文件路径相对命令执行目录;
(4)完全相对路径;
(5)绝对路径。
到这里commitizen就安装完成了。
之后所有用到git commit的地方用git cz替换掉,会出现如下界面:
按照提示进行选择,并继续往下走,根据提示分别输出标题,内容即可,这里不多赘述了。
release自动生成CHANGELOG
安装conventional-changelog-cli:
sudo npm install -g conventional-changelog-cli
基本使用
conventional-changelog -p angular -i CHANGELOG.md -s
以上命令中参数-p angular用来指定使用的 commit message 标准,假如想使用atom的标准,则是:
conventional-changelog -p atom -i CHANGELOG.md -s
参数-i CHANGELOG.md表示从 CHANGELOG.md 读取 changelog, -s 表示读写 changelog 为同一文件。需要注意的是,上面这条命令产生的 changelog 是基于上次 tag 版本之后的变更(Feature、Fix、Breaking Changes等等)所产生的,所以如果你想生成之前所有 commit 信息产生的 changelog 则需要使用这条命令:
conventional-changelog -p angular -i CHANGELOG.md -s -r 0
其中 -r 表示生成 changelog 所需要使用的 release 版本数量,默认为1,全部则是0。其他参数可以直接–help参考,这里不多赘述了。
本文标签: 自动生成UbuntucommitizenCHANGELOG
版权声明:本文标题:ubuntu commitizen安装配置、CHANGELOG自动生成 内容由热心网友自发贡献,该文观点仅代表作者本人, 转载请联系作者并注明出处:https://www.elefans.com/dianzi/1726704482a1081505.html, 本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容,一经查实,本站将立刻删除。
发表评论