Description | Start a pipeline run. Field parameters can be used to provide variable settings for a custom pipeline run. Use the wait parameter to wait for the pipeline to be COMPLETED at least at the PAUSED state (or other state provided by the state parameter) before the action completes. When waiting for a PAUSED or COMPLETED pipeline, the action will fail if the pipeline has a result that is not considered successful unless the continue parameter is specified. Alternatively, the same wait related parameters can a used on a separate getPipeline action enabling multiple pipelines to be started in a script without wait and then followed later by getPipeline with wait to handle results. Use reference parameter to set a specific replacement variable to pipeline number started by this action for later use in a script like for the alternative wait option. |
|---|
Required Parameters | repository, pipeline |
|---|
Optional Parameters | workspace, branch, commit, selector, selectorType, wait, state, reference, timeout, continue, field |
|---|
Type | Start |
|---|
Category | Pipelines |
|---|
Output Formats | |
|---|
Replacement Variables | pipeline, pipelineResult, pipelineState, pipelineUuid, repository, repositoryFullKey, repositoryName, repositoryUuid, workspace, workspaceName, workspaceUuid |
|---|
| Since Version | 10.0 |
|---|
Examples | startPipeline |
|---|
|