How to pass boolean parameter value in pipeline to downstream jobs?

Question

I'm using Jenkins v2.1 with the integrated delivery pipeline feature (https://jenkins.io/solutions/pipeline/) to orchestrate two existing builds (build and deploy).

In my parameterized build I have 3 user parameters setup, which also needs to be selectable in the pipeline.

The pipeline script is as follows:

node: {
    stage 'build'
    build job: 'build', parameters: [[$class: 'StringParameterValue', name: 'target', value: target], [$class: 'ListSubversionTagsParameterValue', name: 'release', tag: release], [$class: 'BooleanParameterValue', name: 'update_composer', value: update_composer]]

    stage 'deploy'
    build job: 'deploy', parameters: [[$class: 'StringParameterValue', name: 'target', value: target]]
}

This works correctly except for the BooleanParameterValue. When I build the pipeline the following error is thrown:

java.lang.ClassCastException: hudson.model.BooleanParameterValue.value expects boolean but received class java.lang.String

How can I resolve this typecasting error? Or even better, is there a less cumbersome way in which I can just pass ALL the pipeline parameters to the downstream job.

How am I able to use (F.e. print the value of 'target') them in my downstream job? — Rod Kimble, Mar 22 '17 at 09:35

score 57 · Answer 1 · edited May 23 '17 at 12:03

57

In addition to Jesse Glick answer, if you want to pass string parameter then use:

build job: 'your-job-name', 
    parameters: [
        string(name: 'passed_build_number_param', value: String.valueOf(BUILD_NUMBER)),
        string(name: 'complex_param', value: 'prefix-' + String.valueOf(BUILD_NUMBER))
    ]

edited May 23 '17 at 12:03

Community

1
1

answered Mar 24 '17 at 10:31

abguy

943
10
12

21

`build job: 'deploy', parameters: [booleanParam(name: 'target', value: target)]` is the equivalient syntax for boolean parameters – Morgan Christiansson Apr 07 '17 at 13:53
this seems to work for newer Jenkins only, see https://issues.jenkins-ci.org/browse/JENKINS-27295 – childno͡.de May 05 '17 at 08:48

score 42 · Accepted Answer · answered May 05 '16 at 11:40

42

Assuming

value: update_composer

was the issue, try

value: Boolean.valueOf(update_composer)

is there a less cumbersome way in which I can just pass ALL the pipeline parameters to the downstream job

Not that I know of, at least not without using Jenkins API calls and disabling the Groovy sandbox.

answered May 05 '16 at 11:40

Jesse Glick

24,539
10
90
112

thanks for your answer. I'll try this next monday when I'm back at work. Have a few days off now. – Bram Gerritsen May 05 '16 at 17:48
10

Your answer works for me. I even found a shorter way when reading the groovy docs. `update_composer.toBoolean()` also works. – Bram Gerritsen May 09 '16 at 06:19
2

+1 for @BramGerritsen comment - this worked for me even in the Groovy sandbox, whereas the `Boolean.valueOf` did not :) – Steve Campbell Dec 21 '16 at 15:02

score 15 · Answer 3 · answered Jun 21 '17 at 11:43

15

like Jesse Jesse Glick and abguy said you can enumerate string into Boolean type:

Boolean.valueOf(string_variable)

or the opposite Boolean into string:

String.valueOf(boolean_variable)

in my case I had to to downstream Boolean parameter to another job. So for this you will need the use the class BooleanParameterValue :

build job: 'downstream_job_name', parameters:
[
[$class: 'BooleanParameterValue', name: 'parameter_name', value: false],
], wait: true

answered Jun 21 '17 at 11:43

dsaydon

4,421
6
48
52

wondering why BooleanParameterValue is not listed in the documentation of the plugin: https://jenkins.io/doc/pipeline/steps/pipeline-build-step/#-build-%20build%20a%20job – Valentin Jacquemin Aug 15 '18 at 13:18

score 13 · Answer 4 · answered Sep 24 '20 at 13:38

13

build job: 'downstream_job_name', parameters: [
    booleanParam(name: 'parameter_name', value: false)
]

(cf. https://www.jenkins.io/doc/pipeline/steps/pipeline-build-step/#-build-%20build%20a%20job)

answered Sep 24 '20 at 13:38

Romain DEQUIDT

792
8
15

score 8 · Answer 5 · answered Jun 26 '18 at 20:58

Jenkins "boolean" parameters are really just a shortcut for the "choice parameter" type with the choices hardcoded to the strings "true" and "false", and with a checkbox to set the string variable. But in the end, it is just that: a string variable, with nothing to do with a true boolean. That's why you need to convert the string to a boolean if you don't want to do a string comparison like:

if (myBoolean == "true")

mfaani · Answer 6 · 2022-01-20T19:10:03.907

Not sure if this answers this question. But I was looking for something else. Highly recommend see this 2 minute video. If you wanted to get into more details then see docs - Handling Parameters and this link

And then if you have something like blue ocean, the choices would look something like this:

_{As discussed in the video, Jenkins is blue because it's using Blue Ocean Plugin}

You define and access your variables like this:

pipeline {
    agent any

    parameters {
    string(defaultValue: "TEST", description: 'What environment?', name: 'userFlag')
    choice(choices: ['TESTING', 'STAGING', 'PRODUCTION'], description: 'Select field for target environment', name: 'DEPLOY_ENV')
    }

    stages {
        stage("foo") {
            steps {
                echo "flag: ${params.userFlag}"
                echo "flag: ${params.DEPLOY_ENV}"
            }
        }
    }
}

Automated builds will pick up the default params. But if you do it manually then you get the option to choose.

And then assign values like this:

This is not related to the question, which is regarding passing downstream parameters to a job — Brandon, Feb 07 '23 at 00:56

score 1 · Answer 7 · answered Jul 02 '20 at 12:00

1

Things are much easier nowadays: the builtin Snippet Generator supports the 'build' step (I don't know since when though).

answered Jul 02 '20 at 12:00

Roman

707
8
16

How to pass boolean parameter value in pipeline to downstream jobs?

7 Answers7

Linked