Jenkins高级篇之Pipeline语法篇-5-Declarative Pipeline语法-post/stages/steps

释放双眼,带上耳机,听听看~!

上一篇学习了Agent的这个指令和相关参数的基本使用,基本上掌握了node这个可选参数就好。这一篇,来学习post和stages指令。

1.post指令基本概述

post部分定义将在Pipeline运行或阶段结束时运行的操作。一些条件后 的块的内支持post:部分 always,changed,failure,success,unstable,和aborted。这些块允许在Pipeline运行或阶段结束时执行步骤,具体取决于Pipeline的状态。

简单来说,post可以放在顶层,也就是和agent{…}同级,也可以放在stage里面。一般放顶层的比较多。而且pipeline代码中post代码块不是必须的,使用post的场景基本上执行完一个构建,进行发送消息通知,例如构建失败会发邮件通知。

基本代码布局:


1
2
3
4
5
6
7
8
9
10
11
12
1Pipeline {
2    agent any
3        stages {
4            stage (‘Test’) {
5        }
6    }
7    post {
8          //写相关post部分代码
9    }
10}
11
12

 

2.不同post条件的基本用法

在post代码块区域,支持多种条件指令,这些指令有always,changed,failure,success,unstable,和aborted。下面分别来介绍这些条件的基本用法。

 

条件1:always

作用:无论Pipeline运行的完成状态如何都会执行这段代码

基本代码:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
1pipeline {
2    agent {
3        node {
4            label ‘xxx-agent-机器’
5            customWorkspace "${env.JOB_NAME}/${env.BUILD_NUMBER}"
6        }
7    }
8    stages {
9        stage (‘Build’) {
10            bat “dir” // 如果jenkins安装在windows并执行这部分代码
11            sh “pwd”  //这个是Linux的执行
12        }
13    }
14    post {
15        always {
16            script {
17                //写相关清除/恢复环境等操作代码
18            }
19        }
20    }
21}
22
23

这个always场景,很容易想到的场景就是,事后清理环境。例如测试完了,对数据库进行恢复操作,恢复到测试之前的环境。

 

条件2:changed

作用:只有当前Pipeline运行的状态与先前完成的Pipeline的状态不同时,才能触发运行。

基本代码:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
1pipeline {
2    agent {
3        node {
4            label ‘xxx-agent-机器’
5            customWorkspace "${env.JOB_NAME}/${env.BUILD_NUMBER}"
6        }
7    }
8    stages {
9        stage (‘Build’) {
10            bat “dir” // 如果jenkins安装在windows并执行这部分代码
11            sh “pwd”  //这个是Linux的执行
12        }
13    }
14    post {
15        changed {
16            script {
17                // 例如发邮件代码
18            }
19        }
20    }
21}
22
23

这个场景,大部分是写发邮件状态。例如,你最近几次构建都是成功,突然变成不是成功状态,里面就触发发邮件通知。当然,使用changed这个指令没success和failure要频率高。

 

条件3:failure

作用:只有当前Pipeline运行的状态与先前完成的Pipeline的状态不同时,才能触发运行。

基本代码:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
1pipeline {
2    agent {
3        node {
4            label ‘xxx-agent-机器’
5            //customWorkspace "${env.JOB_NAME}/${env.BUILD_NUMBER}"
6        }
7    }
8    stages {
9        stage (‘Build’) {
10            bat “dir” // 如果jenkins安装在windows并执行这部分代码
11            sh “pwd”  //这个是Linux的执行
12        }
13    }
14    post {
15        failure {
16            script {
17                // 例如发邮件代码
18            }
19        }
20    }
21}
22
23

这个failure条件一般来说,百分百会写到Pipeline代码中,内容无非就是发邮件通知,或者发微信群,钉钉机器人,还有国外的slack聊天群组等。

 

剩下的三个条件:success, unstable, aborted 我就不写代码介绍,和上面一样的代码结构,简单介绍下这三个条件的含义。Success和上面failure都是只Jenkins job的执行结果。是成功,Jenkins UI这次构建会显示绿色图标;如果是失败,就显示红色图标;如果是取消,也就是aborted状态,就显示灰色图标。还有一个是不稳定状态,叫unstable,这几个单词都是和Jenkins job构建结果的概念,如果你熟悉Jenkins,那么这些概念很简单。本篇要求掌握,always和failure和success的基本使用代码。

 

3.stages 和steps基本使用

前面简单说了steps和step的语法,这里来详细说说steps语法,在Declarative 模式中,只支持steps,不支持在steps {…} 里面嵌套写step{…}。一个stage 下至少有一个steps,一般也就是一个steps。我们可以在一个steps下写调用一个或者几个方法,也就是两三行代码。具体的代码实现,可以放在别的包里面。
stages下可以包含多个stage, 在一个Declarative Pipeline脚本中,只允许出现一次stages。

 

以后我们大部分的pipeline代码都在每一个stage里面的steps下,下面写一个最基础的,还是第二篇文章的这个基础代码。


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
1pipeline {
2    agent any
3    stages {
4        stage('Build') {
5            steps {
6                println "Build"
7            }
8        }
9        stage('Test') {
10            steps {
11                println "Test"
12            }
13        }
14        stage('Deploy') {
15            steps {
16                println "Deploy"
17            }
18        }
19    }
20}
21
22

注:上面println是Groovy的语法,就是一个打印语句。不管以后pipeline代码有多么复杂,都是以这个为基础骨架,例如添加一些try catch语句还有其他的指令。

 

 

 

给TA打赏
共{{data.count}}人
人已打赏
安全经验

职场中的那些话那些事

2021-9-24 20:41:29

安全经验

网站日志统计案例分析与实现

2021-11-28 16:36:11

个人中心
购物车
优惠劵
今日签到
有新私信 私信列表
搜索