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等
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。