TriggerPipeline

TriggerPipeline - Tags

JFrog Pipelines Documentation

Products

JFrog Pipelines

Content Type

User Guide

ft:sourceType

Paligo

This topic lists tags that can be used with Trigger Pipeline steps. For more information on TriggerPipeline Pipeline steps, see TriggerPipeline.

name

An alphanumeric string (underscores are permitted) that identifies the step.

type

Must be TriggerPipeline for this step type.

configuration

Specifies all configuration selections for the step's execution environment. This step inherits the Bash/ PowerShell step configuration tags, including these pertinent tags:

Tag	Description of usage	Required/Optional
`integrations`	Specifies an JFrog Platform Access Token integration. This integration should contain a token that has the appropriate level of access to trigger the specified pipeline.	Required
`pipelineName`	The name of the pipeline that you want to trigger	Required
`stepName`	The name of the step that you want to trigger	Required
`waitForRunCompletion`	Boolean value. When set as `false`, parent pipeline will not wait for the child pipeline to complete before executing. Default value is `true`.	Optional
`branchName`	The name of the branch that you want to trigger. This should be used if your target pipeline comes from a multibranch pipeline source.	Optional May be required
`projectKey`	The unique key of the Project that contains the pipeline that you want to trigger. This should only be used if your target pipeline belongs to a Project.	Optional May be required

In addition, these tags can be defined to support the step's native operation:

Tags derived from Bash

All native steps derive from the Bash step. This means that all steps share the same base set of tags from Bash, while native steps have their own additional tags as well that support the step's particular function. So it's important to be familiar with the Bash step definition, since it's the core of the definition of all other steps.

execution

Declares collections of shell command sequences to perform for pre- and post-execution phases:

Tag	Description of usage	Required/Optional
`onStart`	Commands to execute in advance of the native operation. This is the ideal place to utilize the `set_trigger_payload` utility function to add custom step- and pipeline-level variables to your target.	Optional
`onSuccess`	Commands to execute on successful completion	Optional
`onFailure`	Commands to execute on failed completion	Optional
`onComplete`	Commands to execute on any completion	Optional

The actions performed for the onExecute phase are inherent to this step type and may not be overridden.

environment variables

The TriggerPipeline step utilizes several new environment variables to provide as much information as possible.

These variables can be used to configure the behavior of the TriggerPipeline step

variable name	value
pipelines_poll_interval_seconds	How frequently, in seconds, the step should poll for its nested run status. Defaults to 10 seconds

variable name

value

pipelines_poll_interval_seconds

How frequently, in seconds, the step should poll for its nested run status.

Defaults to 10 seconds

These variables are injected into the environment of the target pipeline

variable name	value
parent_step_id	The unique ID of the TriggerPipeline step
parent_step_name	The name of the TriggerPipeline step
parent_step_url	The URL that links to the TriggerPipeline step
parent_run_id	The unique ID of the run that the TriggerPipeline step belongs to
parent_run_number	The run number of the run that the TriggerPipeline step belongs to

These variables are exported into the TriggerPipeline step environment after the target pipeline's run completes.

variable name	value
nested_run_status	The final status of the triggered run (can be success, failure, error, canceled, timeout, or skipped)
nested_run_number	The run number of the triggered run.
nested_run_duration_seconds	The total duration of the triggered run (in seconds)
nested_run_url	The URL that links to the triggered step