Jenkins - Tags for Pipeline Steps

JFrog Pipelines Documentation

ft:sourceType
Paligo

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

name

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

type

Must be Jenkins for this step type.

configuration

Specifies all configuration selections for the step's execution environment. This step inherits the Bash step configuration tags, with these pertinent tags:

Tag

Description of usage

Required/Optional

integrations

Must specify a named Jenkins Integration.

Required

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

jenkinsJobName

The name of the Jenkins job/pipeline

Required

Important

When adding the jenkinsJobName, do not include the job keyword. The only exception is when job is the name of a folder.

  • Correct: jenkinsJobName: infra/test/frontend-trigger-env

  • Incorrect: jenkinsJobName: infra/job/test/job/frontend-trigger-env

jenkinsBranchName

Required field when the Jenkins Job is configured for multibranch. This tells pipelines which branch to execute.

Optional

buildParameters

Assigns any build parameters and their strings in key:value format. These parameters will be passed to the Jenkins job.

Optional

execution

Execution takes place within the Jenkins job only. This section is not supported for this type of step.