Hoe gebruik ik de Jenkins Pipeline-eigenschappen stap?

Ik bestudeer de mogelijkheden van Jenkins Pipeline:Multibranch. Er wordt gezegd dat een recent geïntroduceerde stap propertiesdaar nuttig zou kunnen zijn, maar ik kan niet vatten hoe het werkt en wat het doel is.

Het hintbericht lijkt niet erg duidelijk:

Hiermee worden de eigenschappen bijgewerkt van de taak die deze stap uitvoert. Vooral handig voor workflows met meerdere branches, zodat Jenkinsfile zelf kan coderen wat anders een statische taakconfiguratie zou zijn.

Dus ik heb een nieuwe pijplijn gemaakt met dit als script (rechtstreeks in Jenkins geplakt, niet in SCM):

properties [[$class: 'ParametersDefinitionProperty',
   parameterDefinitions: [[$class: 'StringParameterDefinition',
       defaultValue: '', description: '', name: 'PARAM1']]
]]

Ik heb het uitgevoerd en er gebeurde niets, de job heeft geen nieuwe parameter ontvangen en zelfs als dat wel het geval was, begrijp ik niet waarom ik dit nodig zou kunnen hebben. Kan iemand het alsjeblieft uitleggen?

UPDATE1: ik heb geprobeerd een dummy-pijplijn met eigenschappenstap in mijn git-repo te plaatsen en vervolgens een multibranch-taak geconfigureerd.

println 1
properties [[$class: 'ParametersDefinitionProperty', parameterDefinitions: [[$class: 'StringParameterDefinition', defaultValue: 'str1', description: '', name: 'PARAM1']]], [$class: 'RebuildSettings', autoRebuild: false, rebuildDisabled: false]]
println 2

Het heeft mijn branch gevonden, een taak gemaakt maar de build is mislukt met:

groovy.lang.MissingPropertyException: No such property: properties for class: groovy.lang.Binding
at groovy.lang.Binding.getVariable(Binding.java:62)
at org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SandboxInterceptor.onGetProperty(SandboxInterceptor.java:185)
at org.kohsuke.groovy.sandbox.impl.Checker$4.call(Checker.java:241)
at org.kohsuke.groovy.sandbox.impl.Checker.checkedGetProperty(Checker.java:238)
at com.cloudbees.groovy.cps.sandbox.SandboxInvoker.getProperty(SandboxInvoker.java:23)
at com.cloudbees.groovy.cps.impl.PropertyAccessBlock.rawGet(PropertyAccessBlock.java:17)
at WorkflowScript.run(WorkflowScript:2)
at ___cps.transform___(Native Method)
at com.cloudbees.groovy.cps.impl.PropertyishBlock$ContinuationImpl.get(PropertyishBlock.java:62)
at com.cloudbees.groovy.cps.LValueBlock$GetAdapter.receive(LValueBlock.java:30)
at com.cloudbees.groovy.cps.impl.PropertyishBlock$ContinuationImpl.fixName(PropertyishBlock.java:54)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:601)
at com.cloudbees.groovy.cps.impl.ContinuationPtr$ContinuationImpl.receive(ContinuationPtr.java:72)
at com.cloudbees.groovy.cps.impl.ConstantBlock.eval(ConstantBlock.java:21)
at com.cloudbees.groovy.cps.Next.step(Next.java:58)
at com.cloudbees.groovy.cps.Continuable.run0(Continuable.java:154)
at org.jenkinsci.plugins.workflow.cps.SandboxContinuable.access$001(SandboxContinuable.java:19)
at org.jenkinsci.plugins.workflow.cps.SandboxContinuable$1.call(SandboxContinuable.java:33)
at org.jenkinsci.plugins.workflow.cps.SandboxContinuable$1.call(SandboxContinuable.java:30)
at org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.GroovySandbox.runInSandbox(GroovySandbox.java:106)
at org.jenkinsci.plugins.workflow.cps.SandboxContinuable.run0(SandboxContinuable.java:30)
at org.jenkinsci.plugins.workflow.cps.CpsThread.runNextChunk(CpsThread.java:164)
at org.jenkinsci.plugins.workflow.cps.CpsThreadGroup.run(CpsThreadGroup.java:277)
at org.jenkinsci.plugins.workflow.cps.CpsThreadGroup.access$000(CpsThreadGroup.java:77)
at org.jenkinsci.plugins.workflow.cps.CpsThreadGroup$2.call(CpsThreadGroup.java:186)
at org.jenkinsci.plugins.workflow.cps.CpsThreadGroup$2.call(CpsThreadGroup.java:184)
at org.jenkinsci.plugins.workflow.cps.CpsVmExecutorService$2.call(CpsVmExecutorService.java:47)
at java.util.concurrent.FutureTask$Sync.innerRun(FutureTask.java:334)
at java.util.concurrent.FutureTask.run(FutureTask.java:166)
at hudson.remoting.SingleLaneExecutorService$1.run(SingleLaneExecutorService.java:112)
at jenkins.util.ContextResettingExecutorService$1.run(ContextResettingExecutorService.java:28)
at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:471)
at java.util.concurrent.FutureTask$Sync.innerRun(FutureTask.java:334)
at java.util.concurrent.FutureTask.run(FutureTask.java:166)
at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1110)
at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:603)
at java.lang.Thread.run(Thread.java:722)

UPDATE2: toen ik hetzelfde script (zoals in UPD1) terug in Jenkins zette en het uitvoerde, vroeg het om nieuwe toestemming method groovy.lang.GroovyObject getProperty java.lang.String. Ik heb het goedgekeurd, de build werd groen, maar er verschenen nog steeds geen wijzigingen in de taakconfiguratie.

Mijn omgeving is: Jenkins 1.625.3, Pipeline+Multibranch 1.13


Antwoord 1, autoriteit 100%

Het gebruik van propertiesmet expliciete methodesyntaxis zal werken, d.w.z.:
properties( [ ... ] )in plaats van properties [ ... ]

Als alternatief werkt het ook zonder als u de parameternaam opgeeft, bijvoorbeeld:

properties properties: [ ... ]

Het definiëren van drie eigenschappen is bijvoorbeeld zo eenvoudig als:

properties([
  parameters([
    string(name: 'submodule', defaultValue: ''),
    string(name: 'submodule_branch', defaultValue: ''),
    string(name: 'commit_sha', defaultValue: ''),
  ])
])
/* Accessible then with : params.submodule, params.submodule_branch...  */

Antwoord 2, autoriteit 4%

Meerkeuze in Jenkins scripted pipeline

properties([
  parameters([
        choice(choices: 'sprint_6\nsprint_7\nsprint_8\nSprint_9', description: 'Select branch to Build', name: 'Branch'),
        choice(choices: 'No\nYes', , name: 'choice2'),
        choice(choices: 'No\nYes', name: 'choice3')
  ])
])

Other episodes