PublishBuildInfo

PublishBuildInfo - Tags

JFrog Pipelines Documentation

Products

JFrog Pipelines

Content Type

User Guide

ft:sourceType

Paligo

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

name

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

type

Must be PublishBuildInfo 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
`inputSteps`	Must specify a named step of one of the following types: Bash PowerShell DockerPush GoPublishModule GoPublishBinary GradleBuild HelmPublish MvnBuild NpmPublish The step must not have set `autoPublishBuildInfo` to `true`.	Required
`outputResources`	Must specify a BuildInfo resource to publish. The `buildName` and `buildNumber` properties are automatically set to `$buildName` and `$buildNumber` if defined, or the `JFROG_CLI_BUILD_NAME` and/or `JFROG_CLI_BUILD_NUMBER` from the environment of the named step for native steps. If `JFROG_CLI_BUILD_NAME` or `JFROG_CLI_BUILD_NUMBER` was not set when the input step ran, the defaults are `$pipeline_name` and `$run_number`. Note If `inputSteps` is a Bash step and `$buildName` or `$buildNumber` are not defined, then this step will fail.	Required

Tag

Description of usage

Required/Optional

inputSteps

Must specify a named step of one of the following types:

The step must not have set autoPublishBuildInfo to true.

Required

outputResources

Must specify a BuildInfo resource to publish. The buildName and buildNumber properties are automatically set to $buildName and $buildNumber if defined, or the JFROG_CLI_BUILD_NAME and/or JFROG_CLI_BUILD_NUMBER from the environment of the named step for native steps. If JFROG_CLI_BUILD_NAME or JFROG_CLI_BUILD_NUMBER was not set when the input step ran, the defaults are $pipeline_name and $run_number.

Note

If inputSteps is a Bash step and $buildName or $buildNumber are not defined, then this step will fail.

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
`envInclude`	Pattern for which environment variables to include. Default is to include all the environment variables.	Optional
`envExclude`	Pattern for which environment variables to exclude. This is applied in addition to the base exclude pattern applied to all build info.	Optional
`forceXrayScan`	When set to true, forces an Xray scan after publishing to Artifactory. Default is false.	Optional
`failOnScan`	When set to true, and when the Xray Policy Rule Fail BuildConfigure a Security Rule checkbox is checked in the Configure a Security Rule window, a failed Xray scan will result in a failure of the step. Default is true.	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.