startPipeline

See also: Actions

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 at least at the PAUSED state (or other state provided by the state parameter). 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, (branch or commit or pullRequest)

Optional Parameters

workspace, selector, selectorType, wait, state, reference, timeout, continue, field

Type

Start

Category

Pipelines

Output Formats

Replacement Variables

pipeline, pipelineResult, pipelineState, pipelineStatus, pipelineUuid, repository, repositoryFullKey, repositoryName, repositoryUuid, workspace, workspaceName, workspaceUuid

Since Version10.0

Examples

startPipeline

Related How To's

Log a request with our support team.

Confluence®, Jira®, Atlassian Bamboo®, Bitbucket®, Fisheye®, and Atlassian Crucible® are registered trademarks of Atlassian®
Copyright © 2005 - 2024 Appfire | All rights reserved. Appfire™, the 'Apps for makers™' slogan and Bob Swift Atlassian Apps™ are all trademarks of Appfire Technologies, LLC.