Global Variable Reference
Variables
The docker variable offers convenient access to Docker-related functions from a Pipeline script.
Methods needing a Jenkins agent will implicitly run a node {…} block if you have not wrapped them in one. It is a good idea to enclose a block of steps which should all run on the same node in such a block yourself. (If using a Swarm server, or any other specific Docker server, this probably does not matter, but if you are using the default server on localhost it likely will.)
Some methods return instances of auxiliary classes which serve as holders for an ID and which have their own methods and properties. Methods taking a body return any value returned by the body itself. Some method parameters are optional and are enclosed with []. Reference:
withRegistry(url[, credentialsId]) {…}
Specifies a registry URL such as https://docker.mycorp.com/, plus an optional credentials ID to connect to it.
withServer(uri[, credentialsId]) {…}
Specifies a server URI such as tcp://swarm.mycorp.com:2376, plus an optional credentials ID to connect to it.
withTool(toolName) {…}
Specifies the name of a Docker installation to use, if any are defined in Jenkins global configuration. If unspecified, docker is assumed to be in the $PATH of the Jenkins agent.
image(id)
Creates an Image object with a specified name or ID. See below.
build(image[, args])
Runs docker build to create and tag the specified image from a Dockerfile in the current directory. Additional args may be added, such as '-f Dockerfile.other --pull --build-arg http_proxy=http://192.168.1.1:3128 .'. Like docker build, args must end with the build context. Returns the resulting Image object. Records a FROM fingerprint in the build.
Image.id
The image name with optional tag (mycorp/myapp, mycorp/myapp:latest) or ID (hexadecimal hash).
Image.run([args, command])
Uses docker run to run the image, and returns a Container which you could stop later. Additional args may be added, such as '-p 8080:8080 --memory-swap=-1'. Optional command is equivalent to Docker command specified after the image. Records a run fingerprint in the build.
Image.withRun[(args[, command])] {…}
Like run but stops the container as soon as its body exits, so you do not need a try-finally block.
Image.inside[(args)] {…}
Like withRun this starts a container for the duration of the body, but all external commands (sh) launched by the body run inside the container rather than on the host. These commands run in the same working directory (normally a Jenkins agent workspace), which means that the Docker server must be on localhost.
Image.tag([tagname])
Runs docker tag to record a tag of this image (defaulting to the tag it already has). Will rewrite an existing tag if one exists.
Image.push([tagname])
Pushes an image to the registry after tagging it as with the tag method. For example, you can use image.push 'latest' to publish it as the latest version in its repository.
Image.pull()
Runs docker pull. Not necessary before run, withRun, or inside.
Image.imageName()
The id prefixed as needed with registry information, such as docker.mycorp.com/mycorp/myapp. May be used if running your own Docker commands using sh.
Container.id
Hexadecimal ID of a running container.
Container.stop
Runs docker stop and docker rm to shut down a container and remove its storage.
Container.port(port)
Runs docker port on the container to reveal how the port port is mapped on the host.
The pipeline step allows you to define your Pipelines in a more structured way. See the wiki for more information.
Environment variables are accessible from Groovy code as env.VARNAME or simply as VARNAME. You can write to such properties as well (only using the env. prefix):
env.MYTOOL_VERSION = '1.33'
node {
sh '/usr/local/mytool-$MYTOOL_VERSION/bin/start'
}
These definitions will also be available via the REST API during the build or after its completion, and from upstream Pipeline builds using the build step.
However any variables set this way are global to the Pipeline build. For variables with node-specific content (such as file paths), you should instead use the withEnv step, to bind the variable only within a node block.
A set of environment variables are made available to all Jenkins projects, including Pipelines. The following is a general list of variable names that are available.
BRANCH_NAME
For a multibranch project, this will be set to the name of the branch being built, for example in case you wish to deploy to production from master but not from feature branches; if corresponding to some kind of change request, the name is generally arbitrary (refer to CHANGE_ID and CHANGE_TARGET).
CHANGE_ID
For a multibranch project corresponding to some kind of change request, this will be set to the change ID, such as a pull request number, if supported; else unset.
CHANGE_URL
For a multibranch project corresponding to some kind of change request, this will be set to the change URL, if supported; else unset.
CHANGE_TITLE
For a multibranch project corresponding to some kind of change request, this will be set to the title of the change, if supported; else unset.
CHANGE_AUTHOR
For a multibranch project corresponding to some kind of change request, this will be set to the username of the author of the proposed change, if supported; else unset.
CHANGE_AUTHOR_DISPLAY_NAME
For a multibranch project corresponding to some kind of change request, this will be set to the human name of the author, if supported; else unset.
CHANGE_AUTHOR_EMAIL
For a multibranch project corresponding to some kind of change request, this will be set to the email address of the author, if supported; else unset.
CHANGE_TARGET
For a multibranch project corresponding to some kind of change request, this will be set to the target or base branch to which the change could be merged, if supported; else unset.
P4_CHANGELIST
P4 Plugin.blurb
P4_CLIENT
P4 Plugin.blurb
P4_PORT
P4 Plugin.blurb
P4_ROOT
P4 Plugin.blurb
P4_USER
P4 Plugin.blurb
P4_TICKET
P4 Plugin.blurb
P4_REVIEW
P4 Plugin.blurb
P4_REVIEW_TYPE
P4 Plugin.blurb
HUDSON_CHANGELOG_FILE
P4 Plugin.blurb
BUILD_NUMBER
The current build number, such as "153"
BUILD_ID
The current build ID, identical to BUILD_NUMBER for builds created in 1.597+, but a YYYY-MM-DD_hh-mm-ss timestamp for older builds
BUILD_DISPLAY_NAME
The display name of the current build, which is something like "#153" by default.
JOB_NAME
Name of the project of this build, such as "foo" or "foo/bar".
JOB_BASE_NAME
Short Name of the project of this build stripping off folder paths, such as "foo" for "bar/foo".
BUILD_TAG
String of "jenkins-${JOB_NAME}-${BUILD_NUMBER}". All forward slashes ("/") in the JOB_NAME are replaced with dashes ("-"). Convenient to put into a resource file, a jar file, etc for easier identification.
EXECUTOR_NUMBER
The unique number that identifies the current executor (among executors of the same machine) that’s carrying out this build. This is the number you see in the "build executor status", except that the number starts from 0, not 1.
NODE_NAME
Name of the agent if the build is on an agent, or "master" if run on master
NODE_LABELS
Whitespace-separated list of labels that the node is assigned.
WORKSPACE
The absolute path of the directory assigned to the build as a workspace.
JENKINS_HOME
The absolute path of the directory assigned on the master node for Jenkins to store data.
JENKINS_URL
Full URL of Jenkins, like http://server:port/jenkins/ (note: only available if Jenkins URL set in system configuration)
BUILD_URL
Full URL of this build, like http://server:port/jenkins/job/foo/15/ (Jenkins URL must be set)
JOB_URL
Full URL of this job, like http://server:port/jenkins/job/foo/ (Jenkins URL must be set)
SCM-specific variables such as GIT_COMMIT are not automatically defined as environment variables; rather you can use the return value of the checkout step.
As an example of loading variable values from Groovy:
mail to: '[email protected]', subject: "Job '${JOB_NAME}' (${BUILD_NUMBER}) is waiting for input", body: "Please go to ${BUILD_URL} and verify the build"
Exposes all parameters defined in the build as a read-only map with variously typed values. Example:
if (params.BOOLEAN_PARAM_NAME) {doSomething()}or to supply a nontrivial default value:
if (params.get('BOOLEAN_PARAM_NAME', true)) {doSomething()}Note for multibranch (Jenkinsfile) usage: the properties step allows you to define job properties, but these take effect when the step is run, whereas build parameter definitions are generally consulted before the build begins. As a convenience, any parameters currently defined in the job which have default values will also be listed in this map. That allows you to write, for example:
properties([parameters([string(name: 'BRANCH', defaultValue: 'master')])])
git url: '…', branch: params.BRANCH
and be assured that the master branch will be checked out even in the initial build of a branch project, or if the previous build did not specify parameters or used a different parameter name.
The currentBuild variable, which is of type RunWrapper, may be used to refer to the currently running build. It has the following readable properties:
number
build number (integer)
result
typically SUCCESS, UNSTABLE, or FAILURE (may be null for an ongoing build)
currentResult
typically SUCCESS, UNSTABLE, or FAILURE. Will never be null.
resultIsBetterOrEqualTo(String)
Compares the current build result to the provided result string (SUCCESS, UNSTABLE, or FAILURE) and returns true if the current build result is better than or equal to the provided result.
resultIsWorseOrEqualTo(String)
Compares the current build result to the provided result string (SUCCESS, UNSTABLE, or FAILURE) and returns true if the current build result is worse than or equal to the provided result.
displayName
normally #123 but sometimes set to, e.g., an SCM commit identifier
description
additional information about the build
id
normally number as a string
timeInMillis
time since the epoch when the build was scheduled
startTimeInMillis
time since the epoch when the build started running
duration
duration of the build in milliseconds
durationString
a human-readable representation of the build duration
previousBuild
another similar object, or null
nextBuild
similarly
absoluteUrl
URL of build index page
buildVariables
for a non-Pipeline downstream build, offers access to a map of defined build variables; for a Pipeline downstream build, any variables set globally on env
changeSets
a list of changesets coming from distinct SCM checkouts; each has a kind and is a list of commits; each commit has a commitId, timestamp, msg, author, and affectedFiles each of which has an editType and path; the value will not generally be Serializable so you may only access it inside a method marked @NonCPS
rawBuild
a hudson.model.Run with further APIs, only for trusted libraries or administrator-approved scripts outside the sandbox; the value will not be Serializable so you may only access it inside a method marked @NonCPS
Additionally, for this build only (but not for other builds), the following properties are writable:
resultdisplayNamedescriptionkeepLog
Represents the SCM configuration in a multibranch project build. Use checkout scm to check out sources matching Jenkinsfile.
You may also use this in a standalone project configured with Pipeline from SCM, though in that case the checkout will just be of the latest revision in the branch, possibly newer than the revision from which the Pipeline was loaded.
Jfrog Artifactory Pipeline DSL.
Full documentation is available here: the plugin's Wiki page.
Executes a groovy script in the Jenkins JVM. Typically, the script checks some conditions and changes accordingly the build result, puts badges next to the build in the build history and/or displays information on the build summary page.
The groovy script can use the variable manager, which provides access to the following objects and methods:
hudson- the current Hudson instance (javadoc).build- the current build (javadoc).listener- the build listener (javadoc).contains(file, regexp)- returns true if the given file contains a line matching regexp.logContains(regexp)- returns true if the build log file contains a line matching regexp.getMatcher(file, regexp)- returns a java.util.regex.Matcher for the first occurrence of regexp in the given file.getLogMatcher(regexp)- returns a java.util.regex.Matcher for the first occurrence of regexp in the build log file.getResult()- returns the current build result.addShortText(text)- puts a badge with a short text, using the default format.addShortText(text, color, background, border, borderColor)- puts a badge with a short text, using the specified format.addBadge(icon, text)- puts a badge with the given icon and text.addBadge(icon, text, link)- puts a badge with the given icon and text linking to link.addInfoBadge(text)- puts a badge with
info icon and the given text.addWarningBadge(text)- puts a badge with
warning icon and the given text.addErrorBadge(text)- puts a badge with
error icon and the given text.createSummary(icon)- creates an entry in the build summary page and returns a summary object corresponding to this entry. You can append text to the summary object by calling its appendText methods:- -
appendText(text, escapeHtml) - -
appendText(text, escapeHtml, bold, italic, color)
- -
buildUnstable()- sets the build result to UNSTABLE.buildFailure()- sets the build result to FAILURE.buildSuccess()- sets the build result to SUCCESS.buildAborted()- sets the build result to ABORTED.buildNotBuilt()- sets the build result to NOT_BUILT.
Example:
if(manager.logContains(".*uses or overrides a deprecated API.*")) {
manager.addWarningBadge("Thou shalt not use deprecated methods.")
manager.createSummary("warning.gif").appendText("<h1>You have been warned!</h1>", false, false, false, "red")
manager.buildUnstable()
}- The script also has two ways of accessing environment variables. The first one is a quick and dirty one time access if you needed only one variable. You could do that with
manager.envVars["variable"]. - If you wanted to get a hashmap of the entire environment, use
def environment = manager.getEnvVars()and simply use environment as a hash map. - See Jenkins Wiki for more information.