最后,当时查看提交历史时,你会看到这样的commit message: docs(docs): 更新README文件 2、validate-commit-msg插件 commitizen 可以保证自己本地的commit message规范,但是无法保证队友也是规范的,所以需要其他工具来检测队友的提交记录是否规范。使用validate-commit-msg 检查队友的commit message规范 #安装 $ npm install...
"husky": {"hooks": {"commit-msg":"commitlint -e$GIT_PARAMS"} } 然后我们正常操作git gitadd. gitcommit-m "test" 上面message不符合提交规范,所以会报错如下: 起到了校验的作用。 四、生成Change Log 如果你的所有 Commit 都符合 Angular 格式,那么发布新版本时, Change log 就可以用脚本自动生成 生成...
如果当前的 commit 是还原到之前的 commit,那么当前 Commit msg Header 要以revert:开头,并且后面紧跟着还原 Commit 的 Header 。这时 Body 里面要以This reverts commit <hash>固定式,其中<hash>是 commit 的 SHA 标示符。 revert: feat(pencil):add'graphiteWidth'option This reverts commit667ecc1654a317a13...
"husky": { "hooks": { "pre-commit": "npm run test", "commit-msg": "commitlint -e $GIT_PARAMS" // 或者 "commitlint -E HUSKY_GIT_PARAMS" }},这样就能对 commit 信息进行 lint 了。8. 根据 commit 信息自动生成 CHANGELOG conventional-changelog-cli 文档 conventional-changelog-cli ...
规范格式 那么如何能优雅而又不失体面的提交你的代码呢?其实我们的git commit message是应该具备一些规范的。目前规范用的比较多的是Angular 团队的规范 message 样例: <type>(<scope>): <subject> <BLANK LINE> <BLANK LINE> Type:必须是下列之一 feat:一个新功能...
"commit": "git-cz" }, "config": { "commitizen": { "path": "./node_modules/cz-conventional-changelog" } } 1. 2. 3. 4. 5. 6. 7. 8. 9. 自定义 Adapter 如果Angular 的规范不符合我们的实际,同样我们也可以通过cz-customizable定制一套符合自己或者团队的规范。
示例: git commit -m "feat(user): add the user login" 二. 使用git hooks校验 1、如果只需要配置单独项目git hooks,可按如下配置: 在.git/hooks目录下有很多钩子,我们可以根据需要自定义不同的内容,这里我们只需要修改commit-msg即可。 首先将commit-msg.sample 改为 commit-msg,也就是去掉后缀。
在日常的开发工作中,我们通常使用 git 来管理代码,当我们对代码进行某项改动后,都可以通过 git commit 来对代码进行提交。 git 规定提交时必须要写提交信息,作为改动说明,保存在 commit 历史中,方便回溯。规范的 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG,甚至对于项目的研发质量都有很大的提升。
Commit Message的格式 Commit msg的格式可以根据公司的情况来定义,在代码提交时做verify判断格式是否正确,如果只是约定格式而没有校验手段的话,格式往往成为摆设。 我们使用的msg格式:[type]:subject, type 必填, 「commit msg 必须使用以下 type 前缀开头,如果不符合规范,代码将无法入库」 ...
{"name":"项目名称","version":"1.1.1","scripts":{// 指令},"dependencies":{// 依赖},"gitHooks":{"commit-msg":"node ./git/index.ts"}} 编写钩子函数 根据指令指向的地址,创建一个git文件夹,在文件下新建一个index.ts文件,写入如下内容: ...