Jenkins指定具体分支持续集成-使用Generic Webhook Trigger插件和码云
Posted Java后端技术
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Jenkins指定具体分支持续集成-使用Generic Webhook Trigger插件和码云相关的知识,希望对你有一定的参考价值。
上一篇:
介绍了如何使用Jenkins通用插件Generic Webhook Trigger 来实现码云WebHooks持续集成,但是有一个问题就是,如果项目是多分支的情况下,每一个分支的提交都会触发Jenkins运行,这一点肯定是我们不想看到的,下边我们就解决一下这个问题。
知识背景
1、使用码云WebHooks进行持续集成的时候,我们首先应该明白,他的原理大致是这样的:当我们每一次提交代码到码云的时候,码云会帮我们发送一个关于Push的Post请求到我们的Jenkins服务器,然后Jenkins持续集成插件Generic Webhook Trigger会接收到请求的参数,对于码云平台,Push 的数据格式是这样子的:
这一点可以在码云WebHooks介绍文档(http://git.mydoc.io/?t=154711)详细的看到。
2、如果我们想自己根据不同的分支的提交情况来触发Jenkins构建,那么我们就应该知道,上述的Post数据哪一个属性代表了不同的分支情况。
3、结果是,Post数据的第三行:
"ref": "refs/heads/master",
代表了不同的分支,我是根据具体的实验数据得到的,实验过程如下:
判断分支标志位的实验过程
1、准备工作
在码云-项目管理-WebHooks下设置:
在8030端口启动一个简单的Web服务(SSM项目),代码如下:
这里的GitOSPostBean 是根据上述码云Push 的JSON数据格式生成的Bean,(插件是IDEA的GsonFormat 这里不再介绍)
2、在1准备工作中,可以看出我实验操作的项目是 jenkins-test , Git分支如下:
3、首先,修改分支develop(全称为:refs/remotes/origin/develop)代码,然后提交代码,查看结果:
可以看到ref的值为:refs/heads/develop
4、然后,修改分支20170727-webhooks(全称为:refs/heads/feature/liugen.xu/20170727-webhooks)代码,然后提交代码,查看结果:
5、可以查看其他数据,最后得出,ref 可以很好的区分不同的分支。
配置Jenkins
配置结果如下:
1、配置就是如此简单,: 只是勾选了Generic Webhook Trigger,什么都没有配置,所以造成任何分支的每一次提交都会触发Jenkins的构建。
Generic Webhook Trigger主要有: Post content parameters、 Header parameters、Request parameters和Optional filter这几个组成。
其中,Post content parameters是对POST请求数据的处理,其他 Header parameters、Request parameters类似,这些都是匹配请求数据中的param,他会判断是否具有指定的这个参数,具体介绍如下:
If you want "param1" in post content { "param1": "value1" }
posted to http://JENKINS_URL/generic-webhook-trigger/invoke
to be contributed, you need to add "$.param1" here.
虽然如此,但是真正能够按照指定分支或参数进行触发的是Optional filter。
Optional filter的介绍是:This is an optional feature. If specified, this job will only trigger when given expression matches given text.
2、对于,上图中(1)(2)(3)(4)解释如下:
(1)筛选参数的变量名,这里是ref;
(2)表达式Expression
,使用‘$.ref’表示请求数据中的ref属性,注意这里有一个点;
(3)Optional filter
的Expression
表示,在Post content parameters
的Expression
中匹配到的数据的格式是否匹配,既是与‘$.ref’匹配的数据。这里应该是先确定触发器的名称,就是(4)中指定的变量;
(4)指定触发器的名字;
总的来说,通过(1)(2)(3)(4)的设置,将请求中的‘ref’属性的值和Optional filter的表达式Expression进行比较,如果匹配则触发Jenkins构建,如果不匹配则不触发。如果只指定(1)(2)而没有(3)(4)的话,他只会在Jenkins构建界面显示匹配到的值和属性,不会按照指定分支进行触发的,如下:
还有一点需要注意的是,(3)中的值是一个正则表达式,我这里配置的是:^(refs/heads/develop)$
意思就是去匹配字符串:refs/heads/develop,测试结果如下:
因此,如果匹配其它分支,替换内容即可,例如:
1、匹配分支refs/heads/master,正则为:^(refs/heads/master)$ ;
2、匹配分支refs/heads/feature/liugen.xu/20170727-webhooks,
正则为:^(refs/heads/feature/liugen.xu/20170727-webhooks)$,
这里注意下,我这里liugen.xu因为有一个点,所以进行了转义;
3、测试结果
结果我这里测试的是正确的,可以查看Jenkins日志:
第一行是指定分支的提交,可以看出是SUCCESS:
[Handling POST /generic-webhook-trigger/invoke from 61.160.47.7 : http-apr-8020-exec-7] org.jenkinsci.plugins.gwt.GenericWebHookRequestReceiver.doInvoke Triggering jenkins-test[Executor #1 for master : executing jenkins-test #23] hudson.model.Run.execute jenkins-test #23 main build action completed: SUCCESS
第一行不是指定分支的提交,可以看出未正确匹配,因此不会触发构建:
[Handling POST /generic-webhook-trigger/invoke from 61.160.47.7 : http-apr-8020-exec-6] org.jenkinsci.plugins.gwt.GenericWebHookRequestReceiver.doInvoke Triggering jenkins-test
[Handling POST /generic-webhook-trigger/invoke from 61.160.47.7 : http-apr-8020-exec-6] org.jenkinsci.plugins.gwt.GenericTrigger.isMatching Not triggering "^(refs/heads/develop)$" not matching "refs/heads/feature/liugen.xu/20170727-webhooks".
总结
如果对你有帮助的话!点击下边广告支持一下!只点击无需关注!谢谢!
以上是关于Jenkins指定具体分支持续集成-使用Generic Webhook Trigger插件和码云的主要内容,如果未能解决你的问题,请参考以下文章