Pipline

Pipline 简介

pipline 语法简介:

pipline 语法-指定节点:

pipeline {
    // agent any // 全局必须带有agent, 表明此pipeline执行节点
    agent { label 'jenkins-node1' } // 基于label指定具体执行的步骤节点,非必须
    stages {
        stage("代码clone") {
            // #agent { label 'master' } // 基于label指定具体执行的步骤节点,非必须
            steps {
                sh "cd /var/lib/jenkins/workspace/pipline-test1 && rm -rf ./*"
                git branch: 'main', credentialsId: '9de167f4-0359-467d-85ba-acabd48c0f23', url: 'git@172.31.5.101:magedu/app1.git'
                echo "代码 clone完成"
            }
        }
        stage("代码构建") {
            // #agent { label 'master' } // 基于label指定具体执行的步骤节点,非必须
            steps {
                sh "cd /var/lib/jenkins/workspace/pipline-linux40-app1-develop && tar czvf linux40.tar.gz ./*"
            }
        }
    }
}
pipeline {
    agent none
    stages {
        stage('代码clone') {
            agent {
                node {
                    label 'jenkins-master'
                    customWorkspace "/data/gitdata/magedu"
                }
            }
            steps {
                sh "echo 代码clone"
            }
        }
        stage('代码部署') {
            agent {
                node {
                    label 'jenkins-master'
                    customWorkspace "/data/gitdata/magedu"
                }
            }
            steps {
                sh "echo 代码部署"
            }
        }
    }
}

基于 input 实现交互式操作:

pipeline {
    agent any
    stages {
        stage('交互测试') {
            input {
                message "是否继续部署?"
                ok "继续部署"
                submitter "jenkinsadmin"
            }
            steps {
                echo "Hello jenkins!"
            }
        }
    }
}

Jenkins通知机制,在声明式Pipeline中使用post;

post指令:

post发送邮件通知示例:

pipline-job-test9 演示在这执行异常后post阶段的操作,cleanup会晚于always执行,发送邮件需要提前配置好 jenkins的邮件通知配置:

pipeline {
    agent any
    stages {
        stage('post测试-代码clone阶段') {
            steps {
                sh 'echo git clone'
                sh 'cd /data/xxx' // 此步骤会执行失败,用于验证构建失败的邮件通知
            }
            post {
                cleanup {
                    echo "post cleanup-->测试是否执行"
                }
                always {
                    echo "post always"
                }
                aborted {
                    echo "post aborted"
                }
                success {
                    script {
                        mail to: '2973707860@qq.com',
                            subject: "Pipeline Name: ${currentBuild.fullDisplayName}",
                            body: "${env.JOB_NAME} - Build Number - ${env.BUILD_NUMBER} - 构建成功!\n点击链接 ${env.BUILD_URL} 查看详情"
                    }
                }
                failure {
                    script {
                        mail to: '2973707860@qq.com',
                            subject: "Pipeline Name: ${currentBuild.fullDisplayName}",
                            body: "${env.JOB_NAME} - Build Number - ${env.BUILD_NUMBER} - 构建失败!\n点击链接 ${env.BUILD_URL} 查看详情"
                    }
                }
            }
        }
    }
}

声明式Pipline快速入门

pipline环境变量:

基于environment传递环境变量:

pipeline {
    agent any
    environment { // 全局的变量,在当前pipeline所有的stage中都会生效
        NAME = 'user1'
        PASSWD = '123456'
    }
    stages {
        stage('环境变量stage1') {
            environment { // 定义在stage中的变量只会在当前stage生效,其他的stage不会生效
                GIT_SERVER = 'git@172.31.5.101:magedu/app1.git'
            }
            steps {
                sh """
                    echo '$NAME'
                    echo '$PASSWD'
                    echo '$GIT_SERVER'
                """
            }
        }
        stage('环境变量stage2') {
            steps {
                sh """
                    echo '$NAME'
                    echo '$PASSWD'
                """
            }
        }
    }
}

pipline参数简介:

pipline参数示例:

示例:

pipeline {
    agent any
    parameters {
        string(name: 'BRANCH', defaultValue: 'develop', description: '分支选择') // 字符串参数,会配置在jenkins的参数化构建过程中
        choice(name: 'DEPLOY_ENV', choices: ['develop', 'production'], description: '部署环境选择') // 选项参数,会配置在jenkins的参数化构建过程中
    }
    stages {
        stage('测试参数1') {
            steps {
                sh "echo $BRANCH"
            }
        }
        stage('测试参数2') {
            steps {
                sh "echo $DEPLOY_ENV"
            }
        }
    }
}

pipline if 指令:

基于 if 指令实现流程判断:

pipeline {
    agent any
    environment {
        // 代码仓库变量
        def BRANCH_NAME = 'main'
    }
    stages {
        stage('if指令测试') {
            steps {
                script {
                    if (env.BRANCH_NAME == 'main') {
                        echo '我是master'
                    } else if (env.BRANCH_NAME == 'develop') {
                        echo '我是develop'
                    } else {
                        echo '我是默认的'
                    }
                }
            }
        }
    }
}

options选项配置参数简介:

options选项配置参数示例:

示例:

pipeline {
    agent any
    environment { // 全局的变量,在当前pipeline所有的stage中都会生效
        NAME = 'user1'
        PASSWD = '123456'
    }
    options { // 定义pipeline参数
        buildDiscarder(logRotator(numToKeepStr: '5')) // 保留5个历史构建版本
        timeout(time: 5, unit: 'MINUTES') // 定义任务执行超时时间5分钟,如果不加unit参数默认时间单位为分钟,支持NANOSECONDS,MICROSECONDS,MILLISECONDS,SECONDS,MINUTES,HOURS,DAYS
        timestamps() // 在控制台显示命令执行的时间,格式为10:58:39
        retry(2) // 流水线构建失败后重试次数为2次
    }
    stages {
        stage('代码clone') {
            environment { // 定义在stage中的变量只会在当前stage生效,其他的stage不会生效
                GIT_SERVER = 'git@172.31.5.101:magedu/app1.git'
            }
            steps {
                sh """
                    echo '代码clone'
                """
            }
        }
    }
}