Jenkins高级篇之Pipeline语法篇-8-Declarative Pipeline指令:input/when
本篇继续学习指令,input和when这两个。其中input很少使用,when使用多一些,特别涉及嵌套以及逻辑控制,使用when比较好。 指令1:input该input指令允许在一个stage{…}显示提示输入等待。在inpt{…}写一些条件,然后用户触发构建这个job,但是这个时候没有接收到有效的input, job会一直在等待中,你可以在例如job #1的output consol...
本篇继续学习指令,input和when这两个。其中input很少使用,when使用多一些,特别涉及嵌套以及逻辑控制,使用when比较好。
指令1:input
该input指令允许在一个stage{…}显示提示输入等待。在inpt{…}写一些条件,然后用户触发构建这个job,但是这个时候没有接收到有效的input, job会一直在等待中,你可以在例如job #1的output console中,点击这个input条件,提供input,构建才会继续。
下面解释input{…}里面支持写那些option。
message
这个option是必须的,这个message会在用户提交构建的页面显示,提示用户提交相关的input条件。
id
这个id是一个可选的option,可以作为这个input的标记符,默认的标记符是这个stage的名称。
ok
这个ok也是一个可选的option, 主要是在ok按钮上显示一些文本,在input表单里。
submitter
这个submitter也是一个可选的option,里面可以写多个用户名称或者组名称,用逗号隔开。意思就是,只有这写名称的对应用户登陆jenkins,才能提交这个input动作,如果不写,默认是任何人都可以提交input。
parameters
这个也是一个可选的option, 和我们前面学的parameters没有区别,就是定义一些参数的地方。
这个input看到这里,估计不好理解,那么下面,结合代码和jenkins环境,你自己操作一下就明白怎么一回事。
代码举例:
pipeline {
agent any
stages {
stage('Example') {
input {
message "Should we continue?"
ok "Yes, we should."
submitter "admin,anthony"
parameters {
string(name: 'PERSON', defaultValue: 'Mr Anthony', description: 'Who should I say hello to?')
}
}
steps {
echo "Hello, ${PERSON}, nice to meet you."
}
}
}
}
上面代码的意思:运行之前,需要提供input,而且这个input提交,只有admin和anthony这两个用户可以,其他用户提交会失败。把这段代码拷贝到一个pipeline类型的job设置的pipeline tab页面。
保存之后,如果在我jenkins环境(第二篇文章提供url和账号),用anthony登陆,点击build now,这个时候,你需要去你触发这个构建号下的output console,可以看到有一个input requested。
点击上面的Input requested, 出现如下页面,点击 Yes, we should, 这个就是一个ok button
然后这个job才会继续执行下去。好了,input是一个比较新的指令,可能有些旧版本的jenkins不支持,这个指令我在实际工作中没有使用到,我的建议,了解下有这个指令就好。
指令2: when
该when指令允许Pipeline根据给定的条件确定是否执行该阶段。该when指令必须至少包含一个条件。如果when指令包含多个条件,则所有子条件必须为舞台执行返回true。这与子条件嵌套在一个allOf条件中相同(见下面的例子)。
更复杂的条件结构可使用嵌套条件建:not,allOf或anyOf。嵌套条件可以嵌套到任意深度。When{…}是写在stage{…}里面一层条件控制,下面来看看when{…}支持的一些内置条件命令。
branch
当正在构建的分支与给出的分支模式匹配时执行阶段,例如:when { branch 'master' }。请注意,这仅适用于多分支Pipeline。
environment
当指定的环境变量设置为给定值时执行阶段,例如: when { environment name: 'DEPLOY_TO', value: 'production' }
expression
当指定的Groovy表达式求值为true时执行阶段,例如: when { expression { return params.DEBUG_BUILD } }
not
当嵌套条件为false时执行阶段。必须包含一个条件。例如:when { not { branch 'master' } }
allOf
当所有嵌套条件都为真时,执行舞台。必须至少包含一个条件。例如:when { allOf { branch 'master'; environment name: 'DEPLOY_TO', value: 'production' } }
anyOf
当至少一个嵌套条件为真时执行舞台。必须至少包含一个条件。例如:when { anyOf { branch 'master'; branch 'staging' } }
举例一个 使用expression条件的when的代码示例。
pipeline {
agent any
environment {
quick_test = false
}
stages {
stage('Example Build') {
steps {
script {
echo 'Hello World'
}
}
}
stage('Example Deploy') {
when {
expression {
return (quick_test == “true” )
}
}
steps {
echo 'Deploying'
}
}
}
}
解释一下,我在environment里面定义了一个键值对“quick_test = false”, 如果就这么跑,第二个stage('Example Deploy') 是不会被执行的,因为不满足when{…}里面的条件。所以,跑的结果分别从Stage view UI和output console就是这样的。
从控制台和Stage view UI看到,第二个Deploy的stage确实没有执行,也没有输出相关打印语句。下面我们去config里面,把quick_test = false 改成quick_test = true,再跑一个构建。结果应该是如下图。
本篇就介绍input和when这两个指令到这里,建议把when里面支持的这几个指令都写一个pipeline代码进行测试下,官网文档还有google都可以找到一些例子。
更多推荐
所有评论(0)