Child pipeline step options

A child pipeline lets you define a step within a pipeline that triggers another pipeline, which can help to streamline more complex workflows into modular pieces and achieve greater parallelism within your pipeline. The following options are used to define a ‘pipeline within a pipeline step’. A child pipeline (or a pipeline within a pipeline) step uses type: pipeline.

The custom property

The custom option is used to define the custom pipeline that is executed when a child pipeline step is executed.

Property — step

Required — Yes (when type: pipeline)

Data type — String (This should match the name of the custom pipeline.)

Allowed parent properties — step

Allowed child properties — none

The script property

The script property should not be included for child pipeline steps, as it will not be executed. The steps in the child pipeline that is referenced by the custom property will be executed instead.

Restricted Properties

Child pipeline steps are just a trigger to execute a separate pipeline within a pipeline. For instance, defining artifacts on a child pipeline step is not valid, as there are no artifacts produced from the child pipeline step; however, steps inside the child pipeline itself may produce artifacts.

The following properties are not supported by pipeline steps and should not be included when using type: pipeline. With the exclusion of deployment, which is not supported in child pipelines, these properties should be used inside the child pipeline itself instead.

• deployment

• stage

• size

• runtime

• output-variables

• caches

• artifacts

• runs-on

• image

• clone

• oidc

• services