在Jenkins声明性流水线中根据分支是否存在选择不同操作

61次阅读

问题描述

在使用Jenkins声明性流水线时，用户希望根据分支的存在与否运行不同的步骤。用户有多个阶段，其中一些适用于所有分支，一些只适用于特定名称的分支。用户希望找到一种根据分支存在与否设置条件的方法，类似于以下伪代码：

if 分支 b 存在
    切换到分支 b
else
    切换到分支 a

用户尝试了一些方法但未成功，他猜想可能可以使用git plugin来实现这个目标。

解决方案

在使用Jenkins声明性流水线时，你可以通过使用内置的when指令结合条件branch来实现只在特定分支执行某些步骤的目标。这个方案适用于多分支流水线。

方案1

在声明性流水线中，可以通过以下步骤实现：

使用when指令来定义条件，其中条件为branch。
在when指令内部，使用分支名称作为参数，比如branch 'master'。

以下是示例代码：

pipeline {
    agent any
    stages {
        stage("Build") {
            when {
                branch "master"
            }
            steps {
                echo "I am a master branch"
            }
        }
    }
}

在上面的示例中，when指令的条件为branch 'master'，这将使得Build阶段只在master分支上运行。

方案2

如果你使用的是Scripted Pipeline，你可以通过访问环境变量BRANCH_NAME来获取当前分支名称，并根据分支名称执行不同操作。

以下是示例代码：

node {
    if (env.BRANCH_NAME == 'master') {
        // 执行分支为 master 的操作
    } else {
        // 执行其他分支的操作
    }
}

请注意，方案2适用于Scripted Pipeline，并且env.BRANCH_NAME并不总是可用。你可以通过在Pipeline中添加steps { sh 'printenv' }来检查环境变量是否存在。

方案3

另一种方法是使用resolveScm步骤，该步骤是由Pipeline: Multibranch plugin提供的。

以下是示例代码：

checkout resolveScm(source: [$class: 'GitSCMSource',
                          credentialsId: '<credentialsId>',
                          id: '_',
                          remote: 'https://your.git.remote/repository.git',
                          traits: [[$class: 'jenkins.plugins.git.traits.BranchDiscoveryTrait']]],
        targets: [BRANCH_NAME, 'master'])

在上面的示例中，resolveScm步骤会检查分支是否存在，如果存在则检出该分支，否则检出master分支。