(三) git pre-push hook 实践一二

  在 (一) 初探 iOS 单元测试 一文中,我们简单提到了执行xcodebuild test可以启动工程的单元测试并输出测试结果,但手动执行此类命令意义是不大的。我们需要的是,把一些测试和lint等命令写在脚本文件里,在代码提交、合并及打包等行为实际发生前,自动执行脚本,以执行的结果决定是否打断上述操作,一定程度上达到控制代码质量的目的。
  在多人协作开发中,我们可以在所有成员进行某些git操作(commit push merge rebase等)前进行代码的验证(Test、Lint等),防止逻辑错误或不合规范的代码更新到远端仓库中。当然,如果团队搭建了自己的git服务器,有Mac服务器,在server端进行git hooks是最好的解决方案,本地仓库也不用进行额外配置。此外,我们也可以做一些Client Hooks,来达到同样的效果。以下内容是笔者对git pre-push hook的一些实践。

手动添加pre-push文件

前往本地仓库,按下command+shift+.查看隐藏文件,目录如下。我们可以看到.git/hooks路径下有一些.sample的文件。


.git/hooks

删除pre-push.sample文件的后缀名,用编辑器打开,写入:

exit 1

保存退出,仓库根目录下,执行:

git push
push log

可以看到push失败。下面我们在pre-push写入单元测试的命令,如果测试通过,pre-push程序正常退出,push成功;测试失败,出错并退出,push失败。写入:

workspace_name() {
  workspace_file=`find . -maxdepth 2 -name *.xcworkspace -exec basename {} \;`
  echo ${workspace_file%.xcworkspace}
}

check_result() {
if [ $? != 0 ]; then
echo "$1 failed!!"
echo "push will not execute"
echo "$?"
exit 1
else
echo "$1 passed."
echo "push will execute"
echo "$?"
fi
}

workspace=$(workspace_name)

xcodebuild -workspace Example/$workspace.xcworkspace -scheme $workspace-Example -destination 'platform=iOS Simulator,OS=11.0,name=iPhone 7' test
check_result "test"

例子是以pod lib create ...创建的标准工作空间,从仓库根目录起以最大深度为2寻找以.xcworkspace结尾的文件名,赋给workspace变量,最后test名为worksapce.xcworkspace scheme为worksapce-Example的工程,测试失败,打印"push will not execute"exit 1;反之打印push will executeexit 0。 仓库根目录下执行:

git push

最后输出:


测试失败,push失败
测试通过,push成功

现在我们已经实现了一些我们想要的效果,但如何让团队里的每个开发成员都收到pre-push hook的规范呢?

自动添加pre-push文件

我们知道,.git文件夹并不会被push到远程仓库,每个成员clone仓库,.git文件夹是会初始化的。也就是说,正常情况下,pre-push hook只对个人有效。但我们可以耍一些小手段,让每个成员仓库.git/hooks路径下都存在我们写好的pre-push文件,这样其他成员的仓库也具备了git pre-push hook功能。

if [ ! -d "$../.git/hooks/pre-push" ]; then
cp ../pre-push ../.git/hooks/pre-push
exit 0
fi

首先,我们写好一个脚本,功能为如果.git/hooks路径下没有pre-push文件,就复制一个进去。如图中add-pre-push-hook.sh文件:


add-pre-push-hook.sh

那这个脚本在什么时候被执行呢?答案是放在我们Target的Run Script下:


Run Script

  注意Run Script 和 add-pre-push-hook.sh 是在.xcodeproj的路径下开始执行的。这样,每当build,就会执行add-pre-push-hook.sh检查.git/hooks文件夹下是否存在pre-push文件并尝试复制进去。下次当开发成员尝试push代码时,便无形中受到了hook!!!这一切对很多工程的基础库的维护做代码检查还是有一定实用价值的。

谢谢观看!欢迎指出文中错误!

参考文档

https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks
http://blog.ittybittyapps.com/blog/2013/09/03/git-pre-push/
http://blog.ricardofilipe.com/post/git-hook-push-master

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,585评论 18 139
  • 1.什么是 Git Hooks 如同其他许多的版本控制系统一样,Git 也具有在特定事件发生之前或之后执行特定脚本...
    就叫yang阅读 3,246评论 3 11
  • 什么是Git Hooks? 话说,如同其他许多的版本控制系统一样,Git也具有在特定事件发生之前或之后执行特定脚本...
    茗涙阅读 11,404评论 0 7
  • 《祭美》 我讨厌一切规划好的事物,那些条条框框,或那般按部就班地实行,虽是一种规律,却也破坏了自然之美,会少了些许...
    点点星灯阅读 497评论 0 1
  • 今天是光谱的黄种子,简言之释放出好的意念。光谱是代表着释放和放下。黄种子代表你今天种下什么样的种子,定下什么...
    玛雅13月亮历体验记阅读 739评论 0 1