当前位置:首页 > 技术分析 > 正文内容

Jenkins多分支流水线:Webhook按分支触发自动构建

ruisui883个月前 (02-03)技术分析10


Jenkins多分支流水线(Multibranch Pipeline )项目类型能够在同一个项目的不同分支上实现不同的Jenkinsfile。在多分支流水线项目中, Jenkins 自动的发现、管理和执行在源代码控制中包含Jenkinsfile的分支的流水线,这消除了手动创建和管理流水线的需要。

在实际应用中,我们经常需要Git+Jenkins实现代码提交触发Job的自动构建。对于普通Job,webhook自动触发即可;但是对于多分支流水线,每次webhook触发的可能是master、develop或更多分支的构建,这显然是不符合要求的,将会产生很多垃圾的构建历史,给后期查看构建历史排错带来极大的不便。

因此,我们需要的是webhook按分支触发,例如我们的应用场景:

1. Git版本库有master/develop两个分支,分别对应生产和开发环境;

2. develop分支代码提交触发自动构建,master分支手动构建;

自动构建只针对develop分支,这样按分支构建,将会避免master或其他分支产生垃圾构建。

注意:本文只介绍通过generic webhook trigger触发部分,至于git版本库端的webhook请根据实际情况自行配置。

自动构建流程

1. generic webhook trigger 插件实现Jenkins 触发器;

2. 通过插件的正则匹配,基于refs/heads/develop、refs/heads/master进行判断;

(1)若develop分支提交代码,则变量ref=refs/heads/develop,匹配refs/heads/develop,触发构建;

(2)若master分支提交代码,则变量ref=refs/heads/master,不匹配refs/heads/develop,不触发构建;

3.在develop分支中根据Jenkinsfile进入不同的stage构建;

由于触发的是develop分支,则when条件匹配develop分支,develop分支构建;而master分支构建跳过。


关于正则匹配及多分支流水线,请参考以下链接:

1. https://www.jenkins.io/zh/doc/book/pipeline/multibranch/

2. https://plugins.jenkins.io/generic-webhook-trigger/

3. https://github.com/jenkinsci/generic-webhook-trigger-plugin/tree/master/src/test/resources/org/jenkinsci/plugins/gwt/bdd

多分支流水线创建

1.点击Jenkins主页上的 New Item


2.以test命名job

3.配置job

4.Jenkinsfile

git每个分支必须有相同Jenkinsfile文件,否则“Discovery Branches”检测不到分支。

pipeline {
    agent any
  options {
        ansiColor('xterm')
        timestamps()
    }
    triggers {
        GenericTrigger (
            causeString: 'Triggered by develop', 
            genericVariables: [[key: 'ref', value: '$.ref']], 
            printContributedVariables: true, 
            printPostContent: true, 
            regexpFilterExpression: 'refs/heads/' + BRANCH_NAME, 
            regexpFilterText: 'refs/heads/develop', 
            token: 'VXnNT5X/GH8Rs'
        )
    } 
    stages {
      stage("测试部署") {
            when {
                branch 'develop'
            }
          steps {
                echo 'develop branch'
          }
      }
      stage("生产部署") {
            when {
                branch 'master'
            }
          steps {
                echo 'master branch'
          }
      }
    }
    post {
        unstable {
            emailext (
                body: """项目名称:${JOB_NAME}\n构建编号:${BUILD_NUMBER}\n构建日志:${BUILD_URL}console""",
                subject: '【Jenkins构建通知】:$JOB_NAME - Build # $BUILD_NUMBER - Unstable!',
                to: 'admin@test.cn',
                from: 'test@test.cn'
            )   
        }   
        success {
            emailext (
                body: """项目名称:${JOB_NAME}\n构建编号:${BUILD_NUMBER}\n构建日志:${BUILD_URL}console""",
                subject: '【Jenkins构建通知】:$JOB_NAME - Build # $BUILD_NUMBER - Successful!',
                to: 'admin@test.cn',
                from: 'test@test.cn'
            )   
        }   
        failure {
            emailext (
                body: """项目名称:${JOB_NAME}\n构建编号:${BUILD_NUMBER}\n构建日志:${BUILD_URL}console""",
                subject: '【Jenkins构建通知】:$JOB_NAME - Build # $BUILD_NUMBER - Failure!',
                to: 'admin@test.cn',
                from: 'test@test.cn'
            )   
        }   
    } 
}

其中:triggers部分就是本次多分支流水线的关键所在,为便于解释,我们在下面详细介绍

Generic Webhook Trigger 插件

Jenkinsfile中的triggers部分,是Generic Webhook Trigger 插件的具体配置,可以通过Declarative Directive Generator(即声明式指令生成器)图形化生成上面的代码,如下:

1.token配置

token:通过http://JENKINS_URL/generic-webhook-trigger/invoke?token=VXnNT5X/GH8Rs可以触发job。

2.过滤配置

其中:

(1)Expression:通过正则表达式匹配不同分支,此项目有两个分支,即:

refs/heads/master
refs/heads/develop

而'refs/heads' + BRANCH_NAME 中的BRANCH_NAME是通过环境变量获取构建过程中的当前分支。

(2)Text:匹配的结果,即如果通过正则匹配的结果为refs/heads/develop,则触发构建;否则不会触发构建。

3.webhook触发构建

(1)浏览器中通过webhook手动触发构建:

http://x.x.x.x/generic-webhook-trigger/invoke?token=VXnNT5X/GH8Rs


通过上图可看出develop分支触发了自动构建,而master分支则没有触发。

(2)BlueOcean查看



总结

Webhook按分支触发自动构建使多分支流水线更加灵活化,在便于运维集中管理每个项目的分支同时,有效避免了多分支同时构建产生过多的垃圾构建。

扫描二维码推送至手机访问。

版权声明:本文由ruisui88发布,如需转载请注明出处。

本文链接:http://www.ruisui88.com/post/1262.html

分享给朋友:

“Jenkins多分支流水线:Webhook按分支触发自动构建” 的相关文章

景区游船计时收费管理系统--收费分类版

景区游船计时收费管理系统--收费分类版headerfooter《景区游船计时收费管理系统--收费分类版》是专门旅游景区或度假村开发的一款游船计时收费软件。主要功能:1. 基础数据:单位信息、船号状态、脚踏船船号设置、画舫船号设置、船价设置(脚踏船、画舫);2.业务管理:脚踏船(脚踏船开台、脚踏船前台...

Linux 最主要的发行分支

Linux 有数百个发行分支。主要的有以下四个。slackwareSlackware 是由 Patrick Volkerding 在 1992 年推出的,它是全球现存最古老的 Linux 发行版。Slackware 被设计为高度可定制和强大的,并且要求用户了解 每个元素,它的包系统是不支持依赖的。...

Beta版Linux Mint“Xia”发行版22.1发布

IT之家 12 月 13 日消息,Beta 版 Linux Mint“Xia” 22.1 昨日(12 月 12 日)发布,新版本基于 Ubuntu 24.04,内核版本为 Linux 6.8,长期支持将持续到 2029 年,为用户提供可靠稳定的使用体验。新版本在软件包管理方面,主要弃用了传统的 ap...

如何在 Linux 发行版中安装微信和 QQ?

很多人因为工作沟通的原因需要用到微信和 QQ,那么如何在 Linux 发行版中安装微信和 QQ 呢?以下是一些尝试的解决方法。QQ上一个版本的 QQ Linux 版还是在2009年,而在现在,基于 NT 架构的全新 QQ Linux版已经被正式推出,为所有用户提供下载。新版本提供了deb、rpm、A...

《暗黑破坏神 2:重制版》PC 版 2.3 版本发布,支持英伟达 DLSS

IT之家 12 月 3 日消息,暴雪为《暗黑破坏神 2:重制版》PC 版发布了更新 2.3 版本,添加了“离线难度缩放”滑块(玩家可以在单人游戏时增加挑战和奖励的级别)、多项辅助功能和用户界面改进,以及英伟达 DLSS 支持。玩法改进:玩家现在可以在离线游戏的选项菜单中使用“游戏难度等级”,它提供与...

别让“跑焦”毁所有!仅需这一项设置,即可显著改善镜头对焦精度

我常常会收到一些摄影爱好者的私信,也一直在努力的帮助大家解决更多摄影中常见问题。在我收到的所有问题中。有一个问题是最麻烦的,那就是“为什么我的图像看起来模糊?”。这个问题几乎每个人都遇到过,究其原因可以说是多种多样相对复杂。起初我一直认为是对焦问题所导致,也就有了我之前所写的“后按对焦”以及“对焦模...