How to check if build parameter is available in Jenkinsfile
In the latest version of jenkins println(getBinding().hasVariable("myparameter"))
is permitted and does not give an error any more.
Newer versions make the parameters available through the params
variable. If the parameter is not defined, it falls back to the configured default (see also here).
See Getting Started with Pipeline, Build Parameters:
Build Parameters
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.
UPDATE
☑This build is parameterized → Add parameter → String Parameter:
- Name:
STRING_PARAMETER
- Default Value:
STRING_PARAMETER_VALUE
- Name:
Pipeline → Definition:
Pipeline script
→ Script:
def stringParameterExists = true
def otherParameterExists = true
try {
println " STRING_PARAMETER=$STRING_PARAMETER"
}
catch (MissingPropertyException e) {
stringParameterExists = false
}
try {
println " NOT_EXISTING_PARAMETER=$NOT_EXISTING_PARAMETER"
}
catch (MissingPropertyException e) {
otherParameterExists = false
}
println " stringParameterExists=$stringParameterExists"
println " otherParameterExists=$otherParameterExists"
Console Output:
[Pipeline] echo
STRING_PARAMETER=STRING_PARAMETER_VALUE
[Pipeline] echo
stringParameterExists=true
[Pipeline] echo
otherParameterExists=false
[Pipeline] End of Pipeline
Finished: SUCCESS
This is how I did that:
def myParam = false
if (params.myParam != null){
myParam = params.myParam
}
Why do that at all when you can just define parameters in your pipeline as suggested above?
Well, there are situations when you want your pipeline file to work regardless of if parameter is defined or not. I.e., if you're re-using your pipeline script from different Jenkins jobs and you don't want to make people define that parameter ...