Extension Points defined in Pipeline: Step API Plugin

DynamicContext

jenkinsdoc:workflow-step-api:org.jenkinsci.plugins.workflow.steps.DynamicContext]

Allows jenkinsdoc:StepContext=get] to provide a dynamically computed value.

This is registered as an extension, so it may be injected into any build. If you would like to restrict action to a particular step block, use jenkinsdoc:BodyInvoker=withContext] to insert some serializable struct that the dynamic context implementation will look for.</p>

Implementations:

Step

jenkinsdoc:workflow-step-api:org.jenkinsci.plugins.workflow.steps.Step]

One thing that can be done, perhaps asynchronously. A jenkinsdoc:Step] is merely the definition of how this task is configured; jenkinsdoc:StepExecution] represents any state associated with one actual run of it.

Extends from jenkinsdoc:Describable] to support UI-based instantiation. Your step should have a {@code config.jelly} allowing a user to configure its properties, and may have a {@code help.html} and/or {@code help-fieldName.html}, plus {@code doEtc} methods on the jenkinsdoc:StepDescriptor] for form validation, completion, and so on. It should have a jenkinsdoc:DataBoundConstructor] specifying mandatory properties. It may also use jenkinsdoc:DataBoundSetter] for optional properties. All properties also need public getters (or to be public fields) for data binding to work.</p>

Implementations:

StepEnvironmentContributor

jenkinsdoc:workflow-step-api:org.jenkinsci.plugins.workflow.steps.StepEnvironmentContributor]

Contributes environment variables to workflow steps.

Implementations:

StepExecutionIterator

jenkinsdoc:workflow-step-api:org.jenkinsci.plugins.workflow.steps.StepExecutionIterator]

Enumerates active running jenkinsdoc:StepExecution] s in the system.

Implementations: