pipeline最简结构
pipeline{
agent any
stages{
stage('build'){
steps{
echo "我是一个最简结构，缺一不可"
}
}
}
}
- pipeline：代表整条流水线，包含整条流水线的逻辑
- agent：指定流水线的执行器 (在节点上)和工作区
- stages：封装了用于定义流水线主体和逻辑的所有单个阶段定义
- 至少包含一个stage
- stage：代表流水线的阶段，每个阶段都必须有名称
- steps：封装一组DSL步骤
- 至少包含一个步骤
pipeline代码块
agent
- 指定整个流水线或者一个特定的阶段在哪里运行
- agent any：该流水线或阶段可以运行在任何一个定义好的代理节点上
- agent none：在顶端时，代表不设置一个全局的代理节点，同时也代表，如有必要，需要为单个阶段指定一个代理节点
- agent { label "<label>" }：表明该流水线或阶段可以运行在任何一个具有<label>标签的代理节点上
- agent {docker '<image>'}：docker节点，这个在后续学习中继续补充
environment
用于设置环境变量，可定义在stage或pipeline部分
在流水线代码顶部定义的环境，将使流水线所有的步骤都可以访问变量
-
在一个阶段中定义的环境，只能在这个阶段范围内访问变量
pipeline{ environment{ FIRSTNAME = "san" LASTNAME = "zhang" USERNAME = "${LASTNAME}${FIRSTNAME}" } agent any stages{ stage('build'){ steps{ echo "我的名字${USERNAME}" } } } } -
凭证与环境变量
- 学完凭证功能后，再补充
tools
可定义在pipeline或stage部分
会自动下载下载并安装我们指定的工具，并将其加入PATH变量中
-
在全局工具配置(Global Tool Configuration)界面配置工具版本，必须是选择了自动安装
image-20190606165944537.png
pipeline{
agent any
tools{
maven 'maven3-6'
}
stages{
stage('build'){
steps{
sh 'mvn clean test install'
echo "tools命令自动安装maven"
}
}
}
}
options
用于配置jenkins pipeline本身的选项
指定一些属性和值，这些预定义的选项可以应用到整个流水线
-
这些属性一般都可以在jenkins web表单进行基本的配置
image-20190606173114352.png 可以定义在stages或pipeline部分
保留历史构建记录的数量
- 保留指定数量的流水线数量，包含控制台输出以及制品
options{
buildDiscarder(logRotator(numToKeepStr:'10'))
}
指定从版本库中检出源码时的检出目录
拉取代码时，默认检出到工作空间的根目录
-
此选项可以指定检出到工作空间的子目录中
options{ checkoutToSubdirectory('zimulu') }
不允许并发构建
阻止jenkins开始并发执行同一个流水线
-
在某些pipeline存在枪占资源或调用冲突的场景下，此选项非常有用
options{ disableConcurrentBuilds() }
重试次数
如果流水线执行失败，重试运行整个流水线，重试的次数为指定的数量
-
当使用retry选项时，options可以被放在stage块中
options{ retry(2) }
超时
设置一个超时时间，如果超过该时间，整个流水线终止
当使用retry选项时，options可以被放在stage块中
-
unit：SECONDS、MINUTES、HOURS
options{ timeout(time:15, unit:'MINUTES') }
让每个stage都分别运行在一个新的容器中
当agent为docker或dockerfiles时，指定在同一个jenkins节点上，每个stage都分别运行在一个新的容器中
-
不设置的话，是所有的stage都运行在同一个容器中
options{ newContainerPerStage() }
添加时间戳到控制台输出中
这个选项需要安装timestamper插件
-
该选项会全局应用到整个流水线中执行
options{ timestamper() }
其他，后期完善
- skipDefaultCheckout
- skipStagesAfterUnstable
pipeline{
agent any
options{
buildDiscarder(logRotator(numToKeepStr:'10'))
}
stages{
stage('build'){
steps{
echo "保留最近十次的构建"
}
}
}
}
triggers
- 这些触发器并不适用于多分支流水线、Github组织或者Bitbuchet团队/项目等类型的任务
- 需要手动触发一次任务，让jenkins加载后，trigger指令才会生效
cron
定时执行
MINUTE：一小时内的分钟，0~59
HOUR：一天内的小时，0~23
DOM：一个月的某一天，0~31
MONTH：月份，1~12
DOW：星期几，0~7，0和7代表星期天
*：匹配所有值
-
*/<value>：表示每隔<value>
-
*/10 * * * *：每10min执行一次
-
M-N：匹配M到N之间的值
M-N/X 或者 */X：指定在M-N范围内，每隔X执行一次，步长
A,B,······,Z：使用逗号枚举多个值
-
H：代表随机值
-
H 1 * * *：1点的0-59分内随机 -
H(0，30) * * * *：每小时的0-30分内随机 -
H H(0-7) * * *：0点到7:59之间的某个时间点 - H符号在某个范围上的随机值，对于指个项目，他是固定的
-
H/15 * * * *：每15min(可能是:07、:22、:37、52) -
H(0-29)/10 * * * *：前半个小时，每隔10min执行一次(:03、:13、:23) -
45 9-16/2 * * 1-5：每个工作日（周一到周五）从9:45开始到15:45结束，每隔两个小时执行一次 -
H H 1,15 1-11 *：除12月外，每个月的第1天、第15天执行一次
-
// 从周一到周五上午8点开始执行流水线
triggers{
cron('0 8 * * 1-5')
}
pollSCM
- 定期轮询代码仓库是否有变化，有变化则执行
- 设置时间的规则与cron一致
// 每分钟判断一次代码是否有变化
triggers{
pollSCM('*/1 * * * *')
}
upstream
-
由上游任务触发
triggers{ upstream(upstreamProjects:'job1,job2',threshold:hudson.model.Result.SUCCESS) } job1,job2都是任务名
upstreamProjects：接收任务，用
,隔开threshold：上游任务的执行结果是什么值时触发
-
hudson.model.Result是一个枚举，包含以下值
- ABORTED：任务被手动终止
- FAILURE：构建失败
- SUCCESS：构建成功
- UNSTABLE：存在一些错误，但不至于构建失败
- NOT_BUILT：在多阶段构建时，前面阶段的问题导致后面阶段无法执行
parameters
参数化pipeline是指可以通过传参来决定pipeline的行为
参数化让写pipeline就像写函数，可重用
只能放在pipeline块下
-
三个参数
- defaultValue：默认值
- description：参数的描述信息
- name：参数名
-
引用
params.name 多种参数类型
-
string，字符串类型
parameters{ string(name:'DEPLOY_ENV',defaultValue:'staging',description:'string') }image-20190613142009863.png-
等同于
image-20190613142141172.png
-
-
text，多行文本类型，换行使用 \n
parameters{ text(name:'DEPLOY_TEXT',defaultValue:'文本一\n文本二\n文本三',description:'text') }image-20190613142300193.png
-
booleanParam，布尔类型
parameters{ booleanParam(name:'DEBUG_BUILD',defaultValue:'true',description:'booleanParam') }image-20190613142348006.png -
choice，选择参数类型，使用 \n 来分隔多个选项
parameters{ choice(name:'CHOICES',choices:'dev\ntest\nstaging',description:'请选择部署环境') }image-20190613142736693.png
-
file，文件类型，用户可上传文件—不推荐使用
parameters{ file(fileLocation:'',defaultValue:'select the file to upload') }
- password：密码类型
parameters{ password(name:'PASSWORD',defaultValue:'SECRET',description:'password') }image-20190613142848211.png
