Change/extend step properties

  • The Minor Magento version 2.3.0 allows editing and extending steps by reference

  • Any information can get edited and overwritten

Example

<referencePipeline name="pipeline_one">
   <referenceStep name="change_sort_order_of_step" sort_order="120"/>
</referencePipeline>

Description for referencePipeline Blocks

Node Description

referencePipeline/referenceStep

Definition of an existing step.

  • Existing steps can get overwritten or extended using the attribute Name

– name

Required: string

  • Unique identifier

  • Is used for running/executing the step by CLI, can be used for condition rules

– expireIn

Optional: string

  • Defines the maximum execution time of the step

  • If the time is exceeded, the pipeline will be canceled

– sortOrder

Optional: string

  • Definition of step sorting

  • Helpful in resorting to the steps by other modules and extensions

– description

Optional: string

  • Description text for a given step

  • Will be displayed on UI, logs, CLI, …​

– executorType

Required: string

  • Defines the class, which will get executed to run the step

– allowFailure

Optional: boolean

  • Specifies whether the pipeline should continue executing later steps if this step fails.

  • If set to "true", a failure in this step will not stop the pipeline.

  • Default value is "false".

– runAlwaysStep

Optional: boolean

  • If the flag is set, the step will get executed in any case, Even if the pipeline gets canceled or abandoned.

  • A kind of final-Step defines the class, which will get executed to run the step

DEPRECATED

This option is only considered by canceling expired pipelines. Now that the step conditions are only responsible for themselves, it is recommended to use the allowFailure flag. runAlwaysStep now only works in conjunction with the PreviousStepFinished, condition

– remove

Optional: boolean

  • This optional flag removes the referenced original step during the deleting process

  • If there are further references to a deleted step, they will get logged

referencePipeline/referenceStep/conditions

Optional

  • One or multiple conditions that should be set to true to cause the step execution

referencePipeline/referenceStep/conditions/condition

Optional

  • Adds a condition

referencePipeline/referenceStep/conditions/referenceCondition

Optional

  • Overwrites an existing condition

– type

Required: string

  • Defines the class, which will get executed to run the condition check

  • It is the identifier of this condition

– description

Optional: string

  • The Description text for a given condition

  • The Description will get displayed on UI, logs, CLI, …​

– remove

Optional: boolean

  • Deletes an existing condition

referencePipeline/referenceStep/arguments

Optional

  • Holds one or many executor arguments

referencePipeline/referenceStep/arguments/referenceArgument

Optional

  • Extends an Argument

– key

Required: string

  • Required for identification

– value

Optional: string

  • Overwrites the original value of the referenced argument

– remove

Optional: boolean

  • If set to true, the existing argument will get removed