XrayScan - Tags

JFrog Pipelines Documentation

Products

JFrog Pipelines

Content Type

User Guide

ft:sourceType

Paligo

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

name

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

type

Must be XrayScan 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
`inputResources`	Must specify a BuildInforesource . The `buildName` and `buildNumber` are used to trigger the scan.	Required
`outputResources`	May specify a BuildInforesource. The BuildInfo will be updated with the `buildName`and `buildNumber`of the input BuildInfo resource.	Optional

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.

Tag	Description of usage	Required/Optional
`failOnScan`	When set to `true`, and when the Xray Policy Rule Fail Build checkbox is checked in the Configure a Security Build window, a failed Xray scan will result in a failure of the step.Configure a Security Rule Default is `true`.	Optional

Tag

Description of usage

Required/Optional

failOnScan

When set to true, and when the Xray Policy Rule Fail Build checkbox is checked in the Configure a Security Build window, a failed Xray scan will result in a failure of the step.Configure a Security Rule

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.

Note

onExecute, onStart, onSuccess, onFailure, and onComplete are reserved keywords. Using these keywords in any other context in your execution scripts can cause unexpected behavior.