CODEWITHSUNDEEP
jenkinsjenkins-plugins
syk_coder
syk_coder

Reputation: 41

Adding custom job property to Jenkins job

I want to add a new mandatory job property to capture the some custom fields in the jenkins job. I searched in the plugins list but couldn't find any relevant plugin that solves the issue. Is there any plugin to solve this ? (Note: Extra columns plugin doesn't solve my usecase)

Upvotes: 1

Views: 6101

Answers (1)

elworthy
elworthy

Reputation: 474

A freestyle job can be configured to build with parameters. See: https://wiki.jenkins.io/display/JENKINS/Parameterized+Build

You can configure the parameter type (string, boolean, drop down etc), give a description of the parameter and a default value. The string parameters can include validation rules: https://wiki.jenkins.io/display/JENKINS/Validating+String+Parameter+Plugin

Though this only warns when the current parameter value does not meet the regex validation rule, it doesn't prevent the build from being submitted. If submitted in this state, however, the build will fail.

From a quick google, it appears this doesn't work for pipeline jobs, See the last comment on the plugin page url above from Miguelángel Fernández:

If you look at the implementation of class ValidatingStringParameterValue you'll see that it overrides the implementation of public BuildWrapper createBuildWrapper(AbstractBuild build) in a way that aborts if the string is invalid. This will only work on Freestyle jobs and other job types extending AbstractBuild. I'm afraid this does not apply to pipeline jobs. Maybe in your prior project you used freestyle jobs.

An alternative for freestyle jobs is to do in job validation before initiating any build steps using the 'Prepare an environment for the run' from:
https://wiki.jenkins.io/display/JENKINS/EnvInject+Plugin

You would need to write groovy to check the parameters submitted and abort the build at this point if the values aren't suitable. Something like:

def validateString = binding.variables.get('testParam')

if (!binding.variables.get('testParam').matches('\\d+')) {
   println "failure of parameter validation - does not match regex"
   throw new InterruptedException()
} else {
   println "Validation passed carry on with build"
}

This doesn't work on pipeline builds - as the plugin is quote:
'This plugin has some known limitations. For Example, Pipeline Plugin is not fully supported.'.

But if you are using scripted pipelines you can implement something similar:

stage 'start up'
if(!env.testParam.matches('\\d+')) {
    error 'failure of parameter validation - does not match regex'
}

Upvotes: 1

Related Questions