首页 > 数据库 > 数据库开发技术 > 一文学会JenkinsFile怎么写
概念
提供了一套可视化操作界面来帮助创建、编辑 Pipeline 任务它为开发人员提供了更具乐趣的Jenkins使用方式实现了一种全新的、现代风格的用户界面有助于任何规模的团队实现持续交付
流水线编辑器:是一种直观并可视化的流水线编辑器
流水线的可视化:对流水线的可视化表示
流水线的诊断:即刻定位任务问题
个性化仪表盘:用户可以自定义仪表盘,只显示与自身相关的流水线
需要在 Jenkins plugin 中安装 BlueOcean
借用Unix 中的Pipeline思路,一种高内聚低耦合的工具
Jenkins 2.0 以上才会有
一系列 Jenkins 插件将整个持续集成用解释性代码 Jenkinsfile 来描述
Jenkinsfile 使用方法:
Jenkins 任务页面输入源代码工程中编辑
Declarative pipeline
Scripts pipeline

pipeline {
agent any
stages {
stage('Hello') {
steps {
echo 'Hello World'
}
}
}
}





Declarative pipeline - v2.5之后引入,结构化方式Scripts pipeline - 基于 groovy 的语法
a.必须包含在一个pipeline块内,具体来说是:*
pipeline {}*b.基本的部分是“steps”,steps 告诉Jenkins要做什么c.语句分类具体包含Sections, Steps,赋值等几大类

定义pipeline执行节点必须出现的指令参数
any:可以在任意agent上执行pipelinenone:pipeline将不分配全局agent, 每个stage分配自己的agentlabel:指定运行节点的Labelnode:自定义运行节点配置,
指定 label指定 customWorkspace
docker:控制目标节点上的docker运行相关内容
代码举例
pipeline {
agent {
label 'master'
customWorkspace 'myWorkspace'
}
}
必须出现的指令无参数包含一个或多个stage的序列,Pipeline的大部分工作在此执行;每个Pipeline 代码区间中必须只有一个stages
必须出现的指令无参数包含在stages中Pipeline完成的所有实际工作都需要包含到stage中需要定义stage的名字
必须出现的指令无参数具体执行步骤,包含在 stage 代码区间中
代码举例
stages {
stage('pull source code'){
steps {
echo 'pull source code'
sleep 5
}
}
}
pipeline {
agent any
stages {
stage("pull source code"){
steps {
echo "pull source code"
sleep 5
}
}
stage("build"){
steps{
echo "build source code"
sleep 5
}
}
stage("test"){
steps{
echo "run unit test"
}
}
stage("deploy"){
steps{
echo "deploy to the website"
}
}
}
}



定义Pipeline或stage运行结束时的操作不是必须出现的指令参数:
always:无论Pipeline运行的完成状态如何都会运行changed:只有当前Pipeline运行的状态与先前完成的Pipeline的状态不同时,才能运行failure:仅当当前Pipeline处于“失败”状态时才运行success :仅当当前Pipeline具有“成功”状态时才运行unstable:只有当前Pipeline具有“不稳定”状态才能运行aborted:只有当前Pipeline处于“中止”状态时才能运行
pipeline{
agent any
stages {
stage('Test'){
steps{
echo "This is test code"
sleep 2
sh 'exit -1'
}
}
}
post{
always{
echo 'say goodby'
}
success{
echo 'This is success exit'
}
failure{
echo 'This is failure exit'
}
}
}
pipeline{
agent any
stages {
stage('Test'){
steps{
echo "This is test code"
sleep 2
sh 'exit 0'
}
}
}
post{
always{
echo 'say goodby'
}
success{
echo 'This is success exit'
}
failure{
echo 'This is failure exit'
}
}
}
定义pipeline 的专有属性不是必须出现的指令参数:
buildDiscarder:保持构建的最大个数(历史构建个数)disableConcurrentBuilds:不允许并行执行pipeline任务timeout:pipeline 超时时间retry:失败后,重试整个Pipeline的次数timestamps:预定义由Pipeline生成的所有控制台输出时间skipStagesAfterUnstable:一旦构建状态进入了“Unstable”状态,就跳过此stage
pipeline{
agent {
node{
label 'docker_node'
customWorkspace "pipelineWorkspace"
}
}
options {
timeout(time: 10,unit:"SECONDS") //构建超过10s,就会超时
buildDiscarder(logRotator(numToKeepStr:"2")) //最多保留2个最新的构建
retry(5) //失败后尝试运行5次
}
stages {
stage('begin'){
steps{
echo 'hello pipeline begin'
sleep 2
}
}
stage('running'){
steps{
echo 'hello pipeline running'
sleep 2
}
}
stage('finsh'){
steps{
echo 'hello pipeline finsh'
sleep 2
sh "exit 0"
}
}
}
post{
always{
echo 'say goodby'
}
success{
echo 'This is success exit'
}
failure{
echo 'This is failure exit'
}
}
}
控制台输出
Started by user admin
[Pipeline] Start of Pipeline
[Pipeline] node
Running on docker_node in /root/jenkins_mulu/workspace/pipeline_demo_options
[Pipeline] {
[Pipeline] ws
Running in /root/jenkins_mulu/pipelineWorkspace
[Pipeline] {
[Pipeline] timeout
Timeout set to expire in 10 sec
[Pipeline] {
[Pipeline] retry
[Pipeline] {
[Pipeline] stage
[Pipeline] { (begin)
[Pipeline] echo
hello pipeline begin
[Pipeline] sleep
Sleeping for 2 sec
[Pipeline] }
[Pipeline] // stage
[Pipeline] stage
[Pipeline] { (running)
[Pipeline] echo
hello pipeline running
[Pipeline] sleep
Sleeping for 2 sec
[Pipeline] }
[Pipeline] // stage
[Pipeline] stage
[Pipeline] { (finsh)
[Pipeline] echo
hello pipeline finsh
[Pipeline] sleep
Sleeping for 2 sec
[Pipeline] sh
+ exit 0
[Pipeline] }
[Pipeline] // stage
[Pipeline] stage
[Pipeline] { (Declarative: Post Actions)
[Pipeline] echo
say goodby
[Pipeline] echo
This is success exit
[Pipeline] }
[Pipeline] // stage
[Pipeline] }
[Pipeline] // retry
[Pipeline] }
[Pipeline] // timeout
[Pipeline] }
[Pipeline] // ws
[Pipeline] }
[Pipeline] // node
[Pipeline] End of Pipeline
Finished: SUCCESS
pipeline{
agent {
node{
label 'docker_node'
customWorkspace "pipelineWorkspace"
}
}
options {
timeout(time: 10,unit:"SECONDS") //构建超过10s,就会超时
buildDiscarder(logRotator(numToKeepStr:"2")) //最多保留2个最新的构建
retry(5) //失败后尝试运行5次
}
stages {
stage('begin'){
steps{
echo 'hello pipeline begin'
sleep 2
}
}
stage('running'){
steps{
echo 'hello pipeline running'
sleep 2
}
}
stage('finsh'){
steps{
echo 'hello pipeline finsh'
sleep 2
sh "exit -1"
}
}
}
post{
always{
echo 'say goodby'
}
success{
echo 'This is success exit'
}
failure{
echo 'This is failure exit'
}
}
}
parameters
定义pipeline 的专有参数列表不是必须出现的指令参数:
支持数据类型:booleanParam, choice, credentials, file, text, password, run, string类似参数化构建的选项
parameters {
string(name: 'PERSON', defaultValue: 'Jenkins', description: '输入的文本参数')
choice(name: 'CHOICE', choices: ['One', 'Two', 'Three'], description: 'Pick something')
}
pipeline {
agent{
node{
label 'docker_node'
customWorkspace "myWorkspace"
}
}
parameters{
string(name:'PERSON',defaultValue:'Jenkins',description:'输入文本参数')
}
stages{
stage('Test Parameters'){
steps{
echo "Hello ${PERSON}"
}
}
}
}




pipeline {
agent{
node{
label 'docker_node'
customWorkspace "myWorkspace"
}
}
parameters{
string(name:'PERSON',defaultValue:'Jenkins',description:'输入文本参数')
}
environment{
PERSON ="$params.PERSON"
}
stages{
stage('Test Parameters'){
steps{
echo "Hello ${PERSON}"
}
}
}
}
env_tools(有问题)
环境工具变量的定义设置位置:“Manage Jenkins”——> “Global Tool Configuration”
JDK Home的定义

Maven Home的定义

调用java、maven工具
stage('env tools') {
node('docker_node'){
//定义maven java环境
def mvnHome = tool 'maven'
def jdkHome = tool 'jdk11'
//引用环境变量,配置PATH变量
env.PATH = "${mvnHome}/bin:${env.PATH}"
env.PATH = "${jdkHome}/bin:${env.PATH}"
//调用java mvn 工具
sh "java -version"
sh "mvn --version"
}
}
运行结果

基于 groovy 语法定制的一种DSL语言灵活性更高可扩展性更好Script pipeline 与 Declarative pipeline 程序构成方式有雷同之处,基本语句也有相似之处

node {
stage('Example') {
if (env.BRANCH_NAME == 'master') {
echo 'I only execute on the master branch'
} else {
echo 'I execute elsewhere'
}
}
}
stage('Build'){
node {
echo 'this is build stage.'
}
}




场景:异常处理,在运行程序的时候,不希望代码的错误,导致程序的退出使用try进行捕获,使用catch对异常的代码进行处理
stage('Test') {
node{
echo "This is test stage which run on the slave agent."
try {
echo "This is in the try block."
sh 'exit 1'
}catch (exc) {
echo "Something failed, I'm in the catch block."
}finally {
echo "Finally, I'm in the finally block."
}
}
}

stage('Test') {
node{
echo "This is test stage which run on the slave agent."
try {
echo "This is in the try block."
sh 'exit 0'
}catch (exc) {
echo "Something failed, I'm in the catch block."
}finally {
echo "Finally, I'm in the finally block."
}
}
}

定义Pipeline或stage运行时的环境变量不是必须出现的指令无参数
environment {
hlw = 'hello world'
}
pipeline {
agent {
node{
label 'docker_node'
customWorkspace "myWorkspace"
}
}
environment {
hlw = 'hello world'
}
stages {
stage('Print environment_1'){
steps {
echo hlw
sleep 1
}
}
stage('Print environment_2'){
steps {
sh 'echo ${hlw}'
sleep 1
}
}
}
post {
success {
echo 'goodbye pipeline success!'
sleep 5
}
failure {
echo 'ops!!! pipeline failed....'
sleep 5
}
always {
echo 'always say goodbye'
}
}
}
运行结果
triggers:定义了Pipeline自动化触发的方式不是必须出现的指令参数:
cron:接受一个cron风格的字符串来定义Pipeline触发的常规间隔pollSCM:接受一个cron风格的字符串来定义 Jenkins 检查SCM源更改的常规间隔;如果存在新的更改,则Pipeline将被重新触发。
triggers {cron('H/2 * * * *')
}
pipeline {
agent{
node{
label 'docker_node'
customWorkspace "myWorkspace"
}
}
triggers {
cron('H/2 * * * *')
}
stages{
stage('Test Parameters'){
steps{
echo "Hello"
}
}
}
}
原文作者:步步运维步步坑;如有侵权,请联系管理员删除。