Build Pipeline using a Branch Parameter

Question

I seem unable to create a Jenkins Pipeline job that builds a specific branch, where that branch is a build parameter.

Here's some configuration screenshots:

(i've tried with a Git Parameter and a String Parameter, same outcome)

(I've tried $BRANCH_NAME_PARAM, ${BRANCH_NAME_PARAM} and ${env.BRANCH_NAME_PARAM}, same outcome for all variations)

And the build log:

hudson.plugins.git.GitException: Command "git fetch --tags --progress origin +refs/heads/${BRANCH_NAME_PARAM}:refs/remotes/origin/${BRANCH_NAME_PARAM} --prune" returned status code 128:
stdout: 
stderr: fatal: Couldn't find remote ref refs/heads/${BRANCH_NAME_PARAM}

    at org.jenkinsci.plugins.gitclient.CliGitAPIImpl.launchCommandIn(CliGitAPIImpl.java:1970)

I'm obviously doing something wrong - any ideas on what?

score 63 · Accepted Answer · answered Nov 30 '17 at 14:45

63

https://issues.jenkins-ci.org/plugins/servlet/mobile#issue/JENKINS-28447

Appears that its something to do with a lightweight checkout. if i deselect this option in my config, my parameter variables are resolved

answered Nov 30 '17 at 14:45

Chris White

29,949
4
71
93

1

That seems like a bug? – Moberg Jan 14 '20 at 13:37

score 10 · Answer 2 · edited Aug 21 '18 at 12:46

10

a bit more detailed with examples combined with VonC answer

1. Configure extended choice parameter named BRANCH:

specify delimiter
specify groovy script or path to groovy file:

def command = "git ls-remote -h $gitURL"
def proc = command.execute()

proc.waitFor()         

if ( proc.exitValue() != 0 ) {
   println "Error, ${proc.err.text}"
   System.exit(-1)
}     

def branches = proc.in.text.readLines().collect {
it.replaceAll(/[a-z0-9]*\trefs\/heads\//, '') 
}   
return branches.join(",")

2. Set Branches to build: $BRANCH

3. Disable "Lightweight checkout" checkbox in the "Pipeline" secton of Jenkins job configuration:

Otherwise job will fail with following message:"stderr: fatal: Couldn't find remote ref refs/heads/${BRANCH"}"

4. Build with parameter executes groovy script and you will then get a dropdown list of branches

edited Aug 21 '18 at 12:46

Igor Rabkin

85
2
12

answered Nov 30 '17 at 10:28

hopetds

435
2
6

Nice! I was looking for that groovy script. +1 – VonC Nov 30 '17 at 12:07
2

Isn't this what the Git Parameter Plugin already gives you? I get a drop down for my current jobs with a list of all the branches – Chris White Nov 30 '17 at 16:06
Hi @Igor Rabkin I have followed above instructions and it pull the branch list from Git and I have disabled the Lightweight checkout but I still get the error you mentioned. Do you know why? – Kanth Jun 19 '20 at 17:29
Can you help me?? @Hopetds – Kanth Jun 19 '20 at 17:29
@Kanth, It should work... check your configuration again – Igor Rabkin Jun 23 '20 at 06:10

score 6 · Answer 3 · answered Jun 23 '20 at 00:11

I have tried the above solution but it didn't work for me. I have chosen a slightly different approach. I am posting because it will help someone in future.

Goto configures the pipeline job.
Check the option "This project is parameterized"
Add git paramter. Note: If it doesn't show the option, please goto manage plugins and install git parameter plugin.
My pipeline Configure looks like
Uncheck lightweight checkout and update the "branch to build" in pipeline section.
Save the configuration.

I dont have the option "Git Parameter". Why? Searching for a plugin yields "Plugin Page not Found". https://plugins.jenkins.io/git-parameter/ — kiltek, Jul 26 '20 at 07:08

score 0 · Answer 4 · answered Nov 30 '17 at 05:48

Each time I had a job based on a branch, I had to put a groovy script with EnvInject plugin in order to remove the ref/heads part of the git branch selected in parameters.

If you keep refs/heads/xxx, Jenkins will look for the branch ref/heads/ref/heads/xxx.

Build Pipeline using a Branch Parameter

4 Answers4