Jenkins对Gitlab merge requests进行代码检查

引子

当前大部分公司的代码管理业务流使用merge requests方式,当功能开发完成之后由开发发起merge requests将代码合入主干分支。

Jenkins的SCM可以监控git某个分支的状态,如果分支上有新的代码上传则可以触发任务。

用此种方式如果任务失败执行失败,开发修改代码之后需要再次去提交merge请求。如果我们能在merge请求时候触发Jenkins任务则可以大大减少这种情况。

此文介绍使用Jenkins的Gitlab插件和Gitlab的Webhook在merge请求中触发Jenkins任务(代码静态检查)并在请求中备注状态的一种实践。

前提环境

  • Gitlab 12.9.2-ee
  • Jenkins 2.235.5
  • Sonar 7.9.4.35981
  • GitLab Plugin 1.5.13

配置

  1. Jenkins中配置Gitlab权限,该用户权限需要为Developer或Maintainer。其他权限不能上传pipline状态(该权限可单独设置,可找管理员确认)。
  2. Jenkins中创建freestyle任务(pipeline官方插件提示git merge支持不完整)
  3. 输入git地址,如:git@your.gitlab.server:gitlab_group/gitlab_project.git,在高级设置中输入Name为origin,Refspec为+refs/heads/:refs/remotes/origin/ +refs/merge-requests//head:refs/remotes/origin/merge-requests/
  4. 设置Branch Specifier属性,如果项目为单一代码库工作流,输入origin/{gitlabSourceBranch}。为Fork代码工作流则输入merge-requests/{gitlabMergeRequestIid}
  5. 在附加选项中添加Merge before build,其中Name设置为origin,Branch to merge设置为${gitlabTargetBranch}
  6. 设置触发器为Build when a change is pushed to GitLab。选择触发事件为Opened merge requests和comments
  7. 去gitlab页面设置webhook,其中url在上述第六步会提示,token也在第六步高级选型里面生成的,去除SSL验证的勾选,保存并测试webhook可以正确发送
  8. 在build中添加静态代码检查工具,如现在项目用的Sonar(其配置自行上网搜索)
  9. 在构建后操作中添加Publish build status to GitLab,该功能可上传pipeline状态到gitlib。

其他设置

  • 如需添加评论信息在gitlib,可添加Add a note to merge requests到构建后操作中
  • 如需添加投票信息到gitlib,可添加Add Vote for build status on merge requests
  • 如需让构建失败的提交不能合入可在gitlab设置中开启“Pipelines must succeed”选项

常见问题

  • merge请求中查看不到pipeline状态

确认Jenkins中使用的gitlib账户的权限,同时在项目设置中查看pipeline权限。

  • 怎样重新运行检查

因为上述配置中添加了comment触发,可在merge请求中添加备注“jenkins please retry a build”再次触发构建。

  • Gitlib中找不到webhook设置

需要登录账户的权限为Maintainer。

参考

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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