UploadArtifact

UploadArtifact - Tags

JFrog Pipelines Documentation

Products

JFrog Pipelines

Content Type

User Guide

ft:sourceType

Paligo

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

name

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

type

Must be UploadArtifact 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
`integrations`	Must specify an Artifactory Integration or JFrog Platform Access Token Integration .	Required
`inputResources`	May specify a GitRepo, FileSpec, or RemoteFile resource containing the file(s) to be uploaded. One of each type may be specified.	Optional
`outputResources`	Must specify a BuildInfo resource if `autoPublishBuildInfo` is set as `true`. If `JFROG_CLI_BUILD_NAME` or `JFROG_CLI_BUILD_NUMBER` is set as an environment variable for the pipeline or the step, that name and/or number is used for the output BuildInfo. Otherwise, the default `buildName` and `buildNumber` are `$pipeline_name` and `$run_number.` May also specify a FileSpec resource to be updated with the pattern and properties of the uploaded Artifact.	May be required

Tag

Description of usage

Required/Optional

integrations

Must specify an Artifactory Integration or JFrog Platform Access Token Integration .

Required

inputResources

May specify a GitRepo, FileSpec, or RemoteFile resource containing the file(s) to be uploaded. One of each type may be specified.

Optional

outputResources

Must specify a BuildInfo resource if autoPublishBuildInfo is set as true.

If JFROG_CLI_BUILD_NAME or JFROG_CLI_BUILD_NUMBER is set as an environment variable for the pipeline or the step, that name and/or number is used for the output BuildInfo. Otherwise, the default buildName and buildNumber are $pipeline_name and $run_number.

May also specify a FileSpec resource to be updated with the pattern and properties of the uploaded Artifact.

May be required

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

Tag	Description of usage	Required/Optional
targetPath	Path to upload the files, including repository name.	Required
`sourcePath`	Files to upload. If this is a relative path pattern, it is relative to the root of a GitRepo/FileSpec/RemoteFile input. Default is `` when `regExp` is `false` and `.` when `regExp` is `true`.	Optional
`properties`	Semi-colon separated properties for the uploaded artifact. For example: `myFirstProperty=one;mySecondProperty=two`. Properties `pipelines_step_name`, `pipelines_run_number`, `pipelines_step_id`, `pipelines_pipeline_name`, `pipelines_step_url`, `pipelines_step_type`, and `pipelines_step_platform` will also be added.	Optional
`regExp`	When set as `true`, regular expressions are used in other parameters, such as `sourcePath`, instead of wildcards. Expressions must be in parentheses. Default is `false`.	Optional
`flat`	When set as `true`, the uploaded files are flattened, removing the directory structure. Default is `false`.	Optional
`module`	A module name for the Build Info.	Optional
`deb`	A `distribution/component/architecture` for Debian packages. If the distribution, component, or architecture includes a / it must be double-escaped, For example: `distribution/my\\\/component/architecture` for a `my/component` component.	Optional
`recursive`	When set as `false`, do not upload any matches in subdirectories. Default is true.	Optional
`dryRun`	When set as `true`, nothing is uploaded. Default is `false`.	Optional
`symlinks`	When set as `true`, symlinks matching the other criteria are uploaded. Default is `false`.	Optional
`explode`	When set as `true` and the uploaded Artifact is an archive, the archive is expanded. Default is `false`.	Optional
`exclusions`	Semi-colon separated patterns to exclude.	Optional
`includeDirs`	When set as `true`, empty directories matching the criteria are uploaded. Default is `false`.	Optional
`syncDeletes`	A path under which to delete any existing files in Artifactory.	Optional
`forceXrayScan`	When set as `true`, forces an Xray scan after publishing to Artifactory. Default is `false`.	Optional
`failOnScan`	When set as `true`, and when the Xray Policy Rule Fail Build checkbox is checked in the Configure a Security Rule window, a failed Xray scan will result in a failure of the step.Configure a Security Rule Default is `true`.	Optional
`autoPublishBuildInfo`	When set as `true`, publishes build info to Artifactory. Default is `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.

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.