How to access parameters in a Parameterized Build

Question

How do you access parameters set in the  This build is parameterized  section of a  Workflow  Jenkins job   TEST CASE    Create a WORKFLOW job  Enable  This build is parameterized   Add a STRING PARAMETER foo with default value bar text  Add the code below to Workflow Script   node          print  DEBUG  parameter foo     env foo      Run job    RESULT  DEBUG  parameter foo   null

User · Answer

The following snippet gives you access to all Job params      def myparams   currentBuild rawBuild getAction ParametersAction      for  p in myparams             pMap p name toString      p value toString

User · Answer

I think the variable is available directly  rather than through env  when using Workflow plugin  Try   node         print  DEBUG  parameter foo     foo

User · Answer

When you add a build parameter  foo  it gets converted to something which acts like a  bare variable   so in your script you would do   node      echo foo     If you look at the implementation of the workflow script  you will see that when a script is executed  a class called WorkflowScript is dynamically generated   All statements in the script are executed in the context of this class   All build parameters passed down to this script are converted to properties which are accessible from this class   For example  you can do   node       getProperty  foo       If you are curious  here is a workflow script I wrote which attempts to print out the build parameters  environment variables  and methods on the WorkflowScript class   node      echo  I am a   getClass   getName       echo  PARAMETERS     echo                 echo getBinding   getVariables   getClass   getName      def myvariables   getBinding   getVariables      for  v in myvariables           echo    v      myvariables get v          echo STRING PARAM1 getClass   getName       echo  METHODS     echo              def methods   getMetaClass   getMethods       for  method in methods           echo method getName                 echo  PROPERTIES     echo                 properties each  k  v - gt          println    k    v            echo properties    echo properties  class   getName       echo  ENVIRONMENT VARIABLES     echo                             echo  env is     env getClass   getName      def envvars   env getEnvironment      envvars each  k  v - gt          println    k    v            Here is another code example I tried  where I wanted to test to see if a build parameter was set or not   node      groovy lang Binding myBinding   getBinding      boolean mybool   myBinding hasVariable  STRING PARAM1      echo mybool toString      if  mybool           echo STRING PARAM1        echo getProperty  STRING PARAM1        else          echo  STRING PARAM1 is not defined           mybool   myBinding hasVariable  DID NOT DEFINE THIS      if  mybool           echo DID NOT DEFINE THIS        echo getProperty  DID NOT DEFINE THIS        else          echo  DID NOT DEFINE THIS is not defined

User · Answer

Use double quotes instead of single quotes  e g  echo   foo  as opposed to echo   foo   If you configured your pipeline to accept parameters using the Build with Parameters option  those parameters are accessible as Groovy variables of the same name  See Here   You can drop the semicolon      drop the parentheses    and     and use single quotes     instead of double     if you do not need to perform variable substitutions  See Here  This clued me into my problem  though I ve found that only the double     is required to make it work

User · Answer

As per Pipeline plugin tutorial      If you have configured your pipeline to accept parameters when it is built     Build with Parameters     they are accessible as Groovy variables of the same name    So try to access the variable directly  e g    node          print  DEBUG  parameter foo       foo      print  DEBUG  parameter bar     bar

User · Answer

You can also try using parameters directive for making your build parameterized and accessing parameters   Doc  Pipeline syntax  Parameters  Example   pipeline   agent   node   label  test      options   skipDefaultCheckout      parameters       string name   suiteFile   defaultValue      description   Suite File     stages       stage  Initialize             steps             echo    params suiteFile

User · Answer

I tried a few of the solutions from this thread  It seemed to work  but my values were always true and I also encountered the following issue  JENKINS-40235  I managed to use parameters in groovy jenkinsfile using the following syntax  params myVariable  Here s a working example   Solution  print  DEBUG  parameter isFoo       params isFoo print  DEBUG  parameter isFoo     params isFoo     A more detailed  and working  example   node           adds job parameters within jenkinsfile    properties        parameters          booleanParam           defaultValue  false           description   isFoo should be false            name   isFoo                   booleanParam           defaultValue  true           description   isBar should be true            name   isBar                                 test the false value    print  DEBUG  parameter isFoo       params isFoo    print  DEBUG  parameter isFoo     params isFoo      sh  echo sh isFoo is   params isFoo      if  params isFoo    print  THIS SHOULD NOT DISPLAY           test the true value    print  DEBUG  parameter isBar       params isBar    print  DEBUG  parameter isBar     params isBar      sh  echo sh isBar is   params isBar      if  params isBar    print  this should display        Output   Pipeline     Pipeline  properties WARNING  The properties step will remove all JobPropertys currently configured in this job  either from the UI or from an earlier properties step  This includes configuration for discarding old builds  parameters  concurrent builds and build triggers  WARNING  Removing existing job property  This project is parameterized  WARNING  Removing existing job property  Build triggers   Pipeline  echo DEBUG  parameter isFoo   false  Pipeline  echo DEBUG  parameter isFoo   false  Pipeline  sh  wegotrade-test-job  Running shell script   echo sh isFoo is false sh isFoo is false  Pipeline  echo DEBUG  parameter isBar   true  Pipeline  echo DEBUG  parameter isBar   true  Pipeline  sh  wegotrade-test-job  Running shell script   echo sh isBar is true sh isBar is true  Pipeline  echo this should display  Pipeline     Pipeline     node  Pipeline  End of Pipeline Finished  SUCCESS   I sent a Pull Request to update the misleading pipeline tutorial build-parameters quote that says  they are accessible as Groovy variables of the same name        Edit  As Jesse Glick pointed out  Release notes go into more details     You should also update the Pipeline Job Plugin to 2 7 or later  so that build parameters are defined as environment variables and thus accessible as if they were global Groovy variables

User · Answer

To parameter variable add prefix  params   For example   params myParam   Don t forget  if you use some method of myParam  may be you should approve it in  Script approval

User · Answer

Hope the following piece of code works for you   def item   hudson model Hudson instance getItem  MyJob    def value   item lastBuild getEnvironment null  get  foo

User · Answer

Please note  the way that build parameters are accessed inside pipeline scripts  pipeline plugin  has changed  This approach   getBinding   hasVariable  MY PARAM     Is not working anymore  Please try this instead   def myBool   env getEnvironment   containsKey  MY BOOL     Boolean parseBoolean   env MY BOOL     false

[jenkins] How to access parameters in a Parameterized Build?

Examples related to jenkins

Examples related to groovy

Examples related to jenkins-pipeline