• Type: Improvement
• Resolution: Unresolved
• Priority: Minor
• Component/s: job-dsl-plugin
• Labels:

  None
• Environment:

  Jenkins 2.346.2 standard docker image on Ubuntu 20.04, Job DSL plugin 1.81, Docker Pipeline plugin 1.29

[JENKINS-69181] JobDSL API viewer unaware of properties/folderConfig for multibranchPipelineJob

Pavel Roskin created issue - 2022-07-30 22:28

Pavel Roskin made changes - 2022-07-30 22:32

Description

Original: multibranchPipelineJob has a Properties section with the following fields:  * Docker Label  * Docker registry URL  * Registry credentials I could not find anything relevant in the Job DSL API viewer on my Jenkins install. I looked at the config.xml and tried something, and it worked! Which means the API viewer is missing that information. Following is working for me and configuring those fields. multibranchPipelineJob('Foo-Build') {   properties {     folderConfig {       dockerLabel('Foo-Build-Docker')       registry {         url('[https://harbor/')]         credentialsId(null)       }     }   } } Please document folderConfig under properties.

New: multibranchPipelineJob has a Properties section with the following fields:  * Docker Label  * Docker registry URL  * Registry credentials I could not find anything relevant in the Job DSL API viewer on my Jenkins install. I looked at the config.xml and tried something, and it worked! Which means the API viewer is missing that information. Following is working for me and configuring those fields. {code:java} multibranchPipelineJob('Foo-Build') {     properties {         folderConfig {             dockerLabel('Foo-Build-Docker')             registry {                 url('https://harbor/')                 credentialsId(null)             }         }     } } {code} Please document folderConfig under properties.

Pavel Roskin made changes - 2022-07-30 22:33

Environment

Original: Jenkins 2.346.2 standard docker image on Ubuntu 20.04 Job DSL plugin 1.81 Plugins (without dependencies), all up to date:   "cloudbees-bitbucket-branch-source",   "cobertura",   "configuration-as-code",   "crowd2",   "docker-workflow",   "email-ext",   "job-dsl",   "lockable-resources",   "pipeline-stage-view",   "ssh-slaves",   "timestamper"

New: Jenkins 2.346.2 standard docker image on Ubuntu 20.04, Job DSL plugin 1.81, Docker Pipeline plugin 1.29

Collapse comment: Pavel Roskin added a comment - 2022-07-31 06:58

Pavel Roskin added a comment - 2022-07-31 06:58

I tried to make a fix on my own, but it's more complex than I expected. Here are my findings so far.

FolderConfig.java was in pipeline-model-definition-plugin but was removed from it in JENKINS-58732.

docker-workflow-plugin has FolderConfig.java now.

"org.jenkinsci.plugins.pipeline.modeldefinition.config.FolderConfig" is a compatibility alias, the actual location is "org.jenkinsci.plugins.docker.workflow.declarative.FolderConfig"

config.xml is using the above alias name.

There is an example of using "configure" to achieve the same goal as my snippet: https://github.com/samrocketman/jervis/blob/main/jobs/jenkins_job_multibranch_pipeline.groovy#L70

JobDSL has a special file for handling "properties", PropertiesContext.groovy. That's probably where the fix should go.

Expand comment: Pavel Roskin added a comment - 2022-07-31 06:58

Pavel Roskin added a comment - 2022-07-31 06:58 I tried to make a fix on my own, but it's more complex than I expected. Here are my findings so far. FolderConfig.java was in pipeline-model-definition-plugin but was removed from it in JENKINS-58732 . docker-workflow-plugin has FolderConfig.java now. "org.jenkinsci.plugins.pipeline.modeldefinition.config.FolderConfig" is a compatibility alias, the actual location is "org.jenkinsci.plugins.docker.workflow.declarative.FolderConfig" config.xml is using the above alias name. There is an example of using "configure" to achieve the same goal as my snippet: https://github.com/samrocketman/jervis/blob/main/jobs/jenkins_job_multibranch_pipeline.groovy#L70 JobDSL has a special file for handling "properties", PropertiesContext.groovy. That's probably where the fix should go.