Jenkins declarative pipeline: use branch if it exist

Question

I'm currently trying to adopt my declarative pipeline in the following way:

I have multiple stages, some apply for all branches, some only for specific names.

What I'm now searching for is a way to get a when condition for the existance of a branch like this:

if branch b exist checkout branch b else checkout branch a

Sadly I haven't found a solution for it. I'm pretty sure there is a way using the git plugin though.

There's a StackOverflow solution for scripted pipelines, but I can't translate them though.

Can someone help me with this or point me at the right direction?

Chachatonel Hashimotto · Accepted Answer · 2021-09-05 22:48:35Z

When using Declarative Pipelines you can achieve the goal of running some steps only for certain branches by using the when directive with the build-in condition branch:

branch Execute the stage when the branch being built matches the branch pattern (ANT style path glob) given, for example: when { branch 'master' }. Note that this only works on a multibranch Pipeline.

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

If you use Scripted Pipeline, you may also access the BRANCH_NAME from environment variable and do something with it:

if (env.BRANCH_NAME == 'master') { //do something }

Also have a look at Flow Control to understand how you can control the flow of your pipeline.

env.BRANCH_NAME is not always available. Use steps { sh 'printenv'} to check. — Danijel
– Danijel, Commented Jul 18, 2022 at 13:24

mrlov · Accepted Answer · 2020-09-14 11:53:54Z

There's a resolveScm step implemented by the 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'])

Above procedure will look whether $BRANCH_NAME exists, check it out if yes and check out master otherwise.

This is not declarative but could be run in a script block. Declarative pipelines typically do not include a checkout function in a multibranch pipeline. — casey vega
– casey vega, Commented Oct 23, 2019 at 15:09

cowlinator · Accepted Answer · 2019-09-30 13:44:30Z

Sometimes it is easier to ask forgiveness than permission.

Instead of trying to figure out whether branch b exists, just try to check it out.

If it fails, checkout branch a.

script { try { checkout([ $class: 'GitSCM', branches: [[name: 'b']], userRemoteConfigs: [[url: url]] ]) } catch (Exception e) { checkout([ $class: 'GitSCM', branches: [[name: 'a']], userRemoteConfigs: [[url: url]] ]) } }

Nice idea, but you will probably not get the expected result if the checkout fails for any reason other than the branch not existing... — Dan Cornilescu
– Dan Cornilescu, Commented Dec 23, 2019 at 15:30

casey vega · Accepted Answer · 2019-10-23 17:15:03Z

1

pipeline { agent any stages { stage('Tests') { when { branch 'master' } steps { echo 'foo' } } }

edited Oct 23, 2019 at 17:15

casey vega

7487 silver badges12 bronze badges

answered Oct 16, 2018 at 6:59

Ram

1393 bronze badges

Add a comment |

Stack Exchange Network

Jenkins declarative pipeline: use branch if it exist

4 Answers 4

Hot Network Questions

Jenkins declarative pipeline: use branch if it exist

4 Answers 4

Related

Hot Network Questions