编写脚本配合 git hooks 实现 commitMsg 的拼接

作者：甜点cc

2023-06-07
河南
本文字数：861 字
阅读完需：约 3 分钟

背景

系统上线流程里，每次发版都要拆单，生成系统变更号，配合 commitlint 实现提交信息必须关联当前版本的系统变更号，当发版结束的时候，这个系统变更号就失效了，再次使用就会报错。

痛点

校验系统变更号是单向的，本地并不能动态获取系统变更号，每次提交都很麻烦，必须去看一下那长达 9 位的系统变更号

问题解决

思路分析

既然不能动态获取系统变更号，就在本地定义一个系统变更号的常量，编写脚本嵌入 git hooks ，读取本地的系统变更号常量，利用脚本组合提交信息。这样至少在一次发版流程里不用关心系统变更号是什么的问题了，能做的也就这么多了。

代码实现

1、编写 ./git/compose-commit-msg.sh 文件

#!/bin/sh#echo "system-change-code"
# 获取当前分支line=$(head -n +1 .git/HEAD)branch=${line##*/}echo "branch: $branch"
# 获取变更号user=`cat .git/system-change-code.txt | grep systemChangeCode`user=${code##*=}echo "code: $code"
# 获取当前提交者的信息user=`git config user.name`echo "user: $user"
if [ -z "$code" ] ; thenecho "NEED SYSTEM-CHANGE-CODE";exit 1;fi
# $1 参数 就是 .git/COMMIT_EDITMSG 文件# cat $1 读取 git commit -m 输入的提交信息# 组合提交信息commit=[$code]$(cat $1)_${branch}_${user}echo "所有参数: $*"
echo "commit-msg: $commit"
# 将组合的信息重新输出到 .git/COMMIT_EDITMSG 文件echo "$commit" > "$1"

复制代码

2、编写 .git/system-change-code.txt 文件

# 定义系统变更号常量(自己维护)systemChangeCode=abc123456

复制代码

3、在 commit-msg hooks 里面载入 compose-commit-msg.sh 脚本

修改 .git/hooks/commit-msg 文件 git hooks more

#!/bin/bash# husky
# 加入下面代码. "$(dirname "$1")"/compose-commit-msg.sh

复制代码

4、提交测试

git commit -m 'test: 测试提交'
# 回车之后，触发钩子，执行脚本，组合提交信息
# 显示的信息：[dev 4224456] [abc123456]test: 测试提交_dev_xiao

复制代码

测试完成🎈🎈

我是 甜点 cc，个人网站(国外站点): https://blog.i-xiao.space/

公众号：【看见另一种可能】

发布于: 刚刚阅读数: 3

原文链接:【http://xie.infoq.cn/article/6ac3711104fe3c876fe1dc68b】。未经作者许可，禁止转载。

甜点cc

关注

微信公众号：看见另一种可能 2020-04-30 加入

https://blog.i-xiao.space/

发布

暂无评论

创作场景

编写脚本配合 git hooks 实现 commitMsg 的拼接

背景

痛点

问题解决

思路分析

代码实现

1、编写 ./git/compose-commit-msg.sh 文件

2、编写 .git/system-change-code.txt 文件

3、在 commit-msg hooks 里面载入 compose-commit-msg.sh 脚本

4、提交测试

甜点cc

评论