PromoteBuild

PromoteBuild - Tags

JFrog Pipelines Documentation

Products

JFrog Pipelines

Content Type

User Guide

ft:sourceType

Paligo

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

name

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

type

Must be PromoteBuild 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 pertinenttags:

Tag	Description of usage	Required/Optional
`inputResources`	Must specify a named BuildInfo resource whose `buildName` and `buildNumber` properties identify the build to promote.	Required
`outputResources`	Must specify a named BuildInfo resource to map to the promoted build. The BuildInfo will be updated with the `buildName` and `buildNumber` of the input BuildInfo resource, and its `targetRepo` with the value of `targetRepository`.	Required

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

Note

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.

Tag	Description of usage	Required/Optional
`targetRepository`	The name of the repository in Artifactory to promote the build to.	Required
`includeDependencies`	When set to true, promotion will include the build dependencies. Defaults to false.	Optional
`status`	Name of the status to promote the build to.	Optional
`comment`	Comment to include for the promotion.	Optional
`copy`	When set to true, copies the artifacts to the targetRepository vs moving them to the targetRepository. Defaults to false.	Optional

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	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.