Jenkinsfile when 条件判断: 提交合并请求时,不执行某个 stage

已经是第三次修正这篇笔记了,希望不用再改了o(╥﹏╥)o

需求

Gitlab 通过 MR 和合并触发构建,MR 的时候只需要运行 CI ,不需要部署,只有合并后才执行部署动作。

解题思路

思路一(失败)

前提:Jenkins 仅追踪 dev 分支的 triggerOnMergeRequest 和 triggerOnPush 事件。

在部署的 stage 上增加条件判断,当触发构建的事件是 MR 时触发 Deploy,如果不是,则跳过。使用 when 语句自带的判断条件 changeRequest() 和 not{}进行判断,代码示例如下:

stage(“Deploy”){
    when{
        // 结果为 false 才执行
        not{
            // 收到合并请求时,才执行
            changeRequest()
        }
    }
    steps{
        sh "deploy"
    }
}

实际结果和期望结果完全不一致,如果加了 not{} 则 MR 事件和 PUSH 事件都会触发 Deploy,如果不加not{} 则 MR 事件和 PUSH 事件都不会触发 Deploy。研究了官方文档半天,最终也没能解决。

思路二(成功)

when 语句自带的判断条件中,还有一个 equals 用于对比某个参数的环境变量的值是否为期望值,于是我用 sh "printenv"将 MR 事件和 PUSH 时间的环境变量全部打印了出来,找到几个明显不同的环境变量值,如 gitlabActionType、gitlabSourceBranch等。

然后使用对比进行判断,结果就成功了。

stage(“Deploy”){
     when{
        // 当 env.gitlabActionType 的值为 PUSH 时,执行
        equals expected: "PUSH", actual: env.gitlabActionType ;
    }
    steps{
        sh "deploy"
    }
}

由于需要考虑另外一个场景——手动构建,需要执行 Deploy,于是我如法炮制,继续对比了环境变量,最终方案如下所示

最终方案

stage('Deploy') {
            when{
                // 以下任何一个值为 True 时,执行
                anyOf{
                    equals expected: "PUSH", actual: env.gitlabActionType ;
                    equals expected: null, actual: env.gitlabActionType ;
                }
            }
            steps {
                sh 'deploy'
            }
        }

拓展

内置条件

内置条件类型 使用说明 备注
branch 指定分支构建时,触发 仅对于多分支流水线有效
buildingTag 构建 tag 时,触发 -
changelog SCM 的变更日志包含指定内容时,触发 与正则表达式结合使用
changeset SCM 的 changeset 包含指定文件时,触发 与 * 等表达式结合使用,缺省状态不区分大小写,可以使用 caseSensiteve 为 true 来区分大小写
changeRequest 变更请求发生时,触发(比如 GitHub 的 PR、Gitlab 的 MR 以及 Gerrit 的变更等) 如未指定参数则表明每次变更请求都会被触发,分支信息/标题/ author /邮件地址等都可以作为参数传入,从而限制只有这些信息被匹配的时候才会触发。同时可以结合正则表达式使用
environment 当某环境变量被设定为某特定值时,触发 -
equals 某变量与期待值相等时,触发 -
expression 表达式为 true 时,触发 注意返回的字符串必须转为布尔类型才能正确执行
tag TAG_NAME 变量满足匹配模式时,触发 -
not 当条件为 false 时,触发 -
allOf 当所有嵌套条件均为 true 时,触发 至少包含一个条件
anyOf 嵌套条件中至少有一个为 true 时,触发 至少包含一个条件
triggeredBy 当前构建为指定方式所触发时,触发 触发方式为:SCMTrigger、TimerTrigger、UpstreamCause等
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,457评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,837评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,696评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,183评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,057评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,105评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,520评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,211评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,482评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,574评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,353评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,897评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,489评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,683评论 2 335