Change/extend pipeline properties

  • With reference, pipelines can get edited and extended

  • As well as any other information can get edited and overwritten

Example

<referencePipeline name="my_pipeline" description="new description">
    <conditions>
        <pipeline_condition type="new_condition_two"/>
    </conditions>
    <step name="new_step" sortOrder="200">
        <conditions>
            <step_condition type="pip_one_step_condition_one"/>
            <referenceStep_condition type="old_condition" remove="true"/>
        </conditions>
    </step>
    <referenceStep name="existing_step" sortOrder="5"/>
</referencePipeline>

Description for referencePipeline Blocks

Node Description

referencePipeline

Definition of an existing pipeline.

  • By means of the name attribute, existing pipelines can get overwritten or extended

– name

Required: string

  • Unique identifier, which gets used for instantiating a pipeline by CLI

  • Can be used for condition rules

– description

Optional: string

  • Pipeline description

  • Will be displayed in UI and CLI as name of the pipeline

- use-working-directory

Optional: boolean

  • If defined, a working directory will be autogenerated during pipeline instantiation

The path for this directory is configurable and can be retrieved within an executor by
$step->getWorkingDir()

– expire-in

Optional: string

  • Defines the execution time after which the pipeline is cancelled

– remove

Optional: boolean

  • Removes the referenced original pipeline during the delete process

  • See

In case there are further references to a deleted pipeline, they will get logged as well.

referencePipeline/conditions

Optional

  • One or multiple conditions which should be set to true to cause a new pipeline execution

  • See

referencePipeline/conditions/pipeline_condition

Optional

  • Configuration of a pipeline condition

referencePipeline/conditions/referencePipeline_condition

Optional

  • One or multiple conditions which should be set to true to cause a new pipeline execution

  • See

– type

Required: string

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

  • It is also the identifier of this condition

– description

Optional: string

  • Description text for a given condition

  • It will get displayed on UI, logs, CLI

– remove

Optional: boolean

  • If set to true, the original condition gets removed

referencePipeline/step

Optional

  • Add a new step to the referenced pipeline

referencePipeline/referenceStep

Optional

  • Edit an existing step in an existing pipeline See