Blog
Documentation
Plugins
Use-cases

Android C/C++ Docker Embedded GitHub Java Continuous Delivery Python Ruby
Participate
Sub-projects

Overview Blue Ocean Google Summer of Code Infrastructure Jenkins Area Meetups
Resources

Account Management Chat Issue Tracker Mailing Lists Wiki
About

Security Press Conduct
Download

Guided Tour

Index
Create your first Pipeline
Running multiple steps
Defining execution environments
Using environment variables
Recording test results and artifacts
Cleaning up and notifications
Deployment

User Handbook (PDF)

Getting Started with Jenkins
Using Jenkins
Managing Jenkins
Best Practices
Pipeline
Blue Ocean
Jenkins Use-Cases
Operating Jenkins
Scaling Jenkins
Appendix
Glossary

Resources

Pipeline Syntax reference
Pipeline Steps reference
LTS Upgrade Guide

Recent Tutorials

Declarative Pipeline: Notifications and Shared Libraries
Declarative Pipeline: Publishing HTML Reports
Declarative Pipeline for Maven Projects

View all tutorials

Developers

Reference Documentation

Pipeline Steps Reference

The following plugins offer Pipeline-compatible steps. Each plugin link offers more information about the parameters for each step.

Android Signing Plugin
- signAndroidApks: Sign Android APKs
Ansible plugin
- ansiblePlaybook: Invoke an ansible playbook
AnsiColor
- ansiColor: Color ANSI Console Output
Artifactory Plugin
- ArtifactoryGradleBuild: run Artifactory gradle
- ArtifactoryMavenBuild: run Artifactory maven
- MavenDescriptorStep: Get Artifactory Maven descriptor
- artifactoryDownload: Download artifacts
- artifactoryPromoteBuild: Promote build
- artifactoryUpload: Upload artifacts
- collectEnv: Collect environment variables and system properties
- dockerPullStep: Artifactory docker pull
- dockerPushStep: Artifactory docker push
- getArtifactoryServer: Get Artifactory server from Jenkins config
- newArtifactoryServer: Returns new Artifactory server
- newBuildInfo: New buildInfo
- newGradleBuild: New Artifactory gradle executor
- newMavenBuild: New Artifactory maven
- publishBuildInfo: Publish build Info to Artifactory
- xrayScanBuild: Xray build scanning
AWS CodeBuild Plugin for Jenkins
- awsCodeBuild: Invoke an AWS CodeBuild build
BearyChat Plugin
- bearychatSend: Send Bearychat Message
Bitbucket Build Status Notifier Plugin
- bitbucketStatusNotify: Notify a build status to BitBucket.
Black Duck Hub Plugin for Jenkins
- hub_scan: Black Duck Hub Integration
- hub_scan_failure: Black Duck Hub Failure Conditions (Hub 3.0+)
Brakeman Plugin
- publishBrakeman: Publish Brakeman reports
CloudShare Docker-Machine Plugin
- cloudshareDockerMachine: CloudShare Docker-Machine
Codefresh Integration Plugin
- codefresh: Run a Codefresh Build
Contrast Continuous Application Security
- contrastAgent: Download latest Contrast agent
- contrastVerification: Verify vulnerabilities in a build
Credentials Binding Plugin
- withCredentials: Bind credentials to variables
cucumber-slack-notifier
- cucumberSlackSend: Send cucumber notifications to slack
deployment-notification
- awaitDeployment: Awaiting for deployment
Docker Pipeline
- dockerFingerprintFrom: Record trace of a Docker image used in FROM
- dockerFingerprintRun: Record trace of a Docker image run in a container
- withDockerContainer: Run build steps inside a Docker container
- withDockerRegistry: Sets up Docker registry endpoint
- withDockerServer: Sets up Docker server endpoint
Docker Slaves Plugin
- dockerNode: Allocate a docker node
Email Extension Plugin
- emailext: Extended Email
- emailextrecipients: Extended Email Recipients
External Workspace Manager Plugin
- exws: Use external workspace
- exwsAllocate: Allocate external workspace
Figlet Buildstep
- figlet: Figlet
Gatling Jenkins Plugin
- gatlingArchive: Archive Gatling reports
Gerrit Trigger
- setGerritReview: Set Gerrit review
Git plugin
- git: Git
GitHub Integration Plugin
- setGitHubPullRequestStatus: Set GitHub PullRequest Commit Status
GitLab Plugin
- acceptGitLabMR: Accept GitLab Merge Request
- addGitLabMRComment: Add comment on GitLab Merge Request
- gitlabBuilds: Notify gitlab about pending builds
- gitlabCommitStatus: Update the commit status in GitLab depending on the build status
- updateGitlabCommitStatus: Update the commit status in GitLab
HipChat Plugin
- hipchatSend: Send HipChat Message
HP Application Automation Tools
- loadRunnerTest: Run LoadRunner performance scenario tests
- sseBuildAndPublish: Execute HP tests using HP ALM Lab Management and Publish HP tests result
- svChangeModeStep: SV: Change Mode of Virtual Service
- svDeployStep: SV: Deploy Virtual Service
- svExportStep: SV: Export Virtual Service
- svUndeployStep: SV: Undeploy Virtual Service
- uftScenarioLoad: Run UFT scenario
HTML Publisher plugin
- publishHTML: Publish HTML reports
HTTP Request Plugin
- httpRequest: Perform an HTTP Request and return a response object
Hubot Pipeline Steps
- hubotApprove: Hubot: Send approval message
- hubotSend: Hubot: Send message
JIRA Pipeline Steps
- jiraAddComment: JIRA Steps: Add Comment
- jiraAddWatcher: JIRA Steps: Add Watcher
- jiraAssignIssue: JIRA Steps: Assign Issue
- jiraEditComment: JIRA Steps: Edit Issue Comment
- jiraEditComponent: JIRA Steps: Edit Component
- jiraEditIssue: JIRA Steps: Edit Issue
- jiraEditVersion: JIRA Steps: Edit Version
- jiraGetComment: JIRA Steps: Get Issue Comment
- jiraGetComments: JIRA Steps: Get Issue Comments
- jiraGetComponent: JIRA Steps: Get Component
- jiraGetComponentIssueCount: JIRA Steps: Get Component Issue Count
- jiraGetIssue: JIRA Steps: Get Issue
- jiraGetIssueLinkTypes: JIRA Steps: Get Issue Link Types
- jiraGetIssueTransitions: JIRA Steps: Get Issue Transitions
- jiraGetIssueWatches: JIRA Steps: Get Issue Watches
- jiraGetProject: JIRA Steps: Get Project
- jiraGetProjects: JIRA Steps: Get Projects
- jiraGetVersion: JIRA Steps: Get Version
- jiraJqlSearch: JIRA Steps: JQL Search
- jiraLinkIssues: JIRA Steps: Link Issues
- jiraNewComponent: JIRA Steps: Create New Component
- jiraNewIssue: JIRA Steps: Create New Issue
- jiraNewIssues: JIRA Steps: Create New Issues
- jiraNewVersion: JIRA Steps: Create New Version
- jiraNotifyIssue: JIRA Steps: Notify Issue
- jiraTransitionIssue: JIRA Steps: Transition Issue
JIRA plugin
- jiraComment: JIRA: Add a comment to issue(s)
- jiraIssueSelector: JIRA: Issue selector
- jiraSearch: JIRA: Search issues
JMS Messaging Plugin
- sendCIMessage: CI Notifier
- waitForCIMessage: CI Subscriber
Job Cacher plugin
- cache: Caches files from previous build to current build
Kubernetes :: Pipeline :: DevOps Steps
- approveReceivedEvent: Updates an Approve event in Elasticsearch
- approveRequestedEvent: Creates an Approve requested event in Elasticsearch
- createEvent: Creates a JSON payload event in Elasticsearch
- kubernetesApply: Apply resources to Kubernetes, lazily creating environments and routes
Kubernetes :: Pipeline :: Kubernetes Steps
- buildImage: Builds a Docker Image
- pushImage: Pushes a Docker Image
- tagImage: Tags a Docker Image
- withPod: Run build steps in a Pod
Kubernetes plugin
- container: Run build steps in a container
- podTemplate: Define a podTemplate to use in the kubernetes plugin
Liquibase Runner
- liquibaseDbDoc: Generate Liquibase DbDoc
- liquibaseRollback: Roll back liquibase changes
- liquibaseUpdate: Evaluate liquibase changesets
Lockable Resources plugin
- lock: Lock shared resource
Marathon Deployment
- marathon: Marathon Deployment
Mattermost Notification Plugin
- mattermostSend: Send Mattermost message
Mock Load Builder Plugin
- mockLoad: Mock Load
Nexus Artifact Uploader
- nexusArtifactUploader: Nexus Artifact Uploader
Office 365 Connector
- office365ConnectorSend: office365ConnectorSend
OpenShift Client Jenkins Plugin
- _OcAction: Internal utility function for OpenShift DSL
- _OcContextInit: Internal utility function for OpenShift DSL
- _OcWatch: Internal utility function for OpenShift DSL
OpenShift Pipeline Jenkins Plugin
- openshiftBuild: Trigger OpenShift Build
- openshiftCreateResource: Create OpenShift Resource(s)
- openshiftDeleteResourceByJsonYaml: Delete OpenShift Resource(s) from JSON/YAML
- openshiftDeleteResourceByKey: Delete OpenShift Resource(s) by Key
- openshiftDeleteResourceByLabels: Delete OpenShift Resource(s) using Labels
- openshiftDeploy: Trigger OpenShift Deployment
- openshiftExec: OpenShift Exec
- openshiftImageStream: OpenShift ImageStreams
- openshiftScale: Scale OpenShift Deployment
- openshiftTag: Tag OpenShift Image
- openshiftVerifyBuild: Verify OpenShift Build
- openshiftVerifyDeployment: Verify OpenShift Deployment
- openshiftVerifyService: Verify OpenShift Service
P4 Plugin
- p4: P4 Groovy (BETA)
- p4cleanup: P4 Cleanup
- p4publish: P4 Publish
- p4sync: P4 Sync
- p4tag: P4 Tag
- p4unshelve: P4 Unshelve
Parallel Test Executor Plugin
- splitTests: Split Test Runs
Pipeline Dependency Walker Plugin
- walk: Execute a pipeline task for the job and all its downstream jobs.
Pipeline GitHub Notify Step Plugin
- githubNotify: Notifies GitHub of the status of a Pull Request
Pipeline Maven Integration Plugin
- withMaven: Provide Maven environment
Pipeline NPM Integration Plugin
- withNPM: Provide NPM environment
Pipeline Utility Steps
- findFiles: Find files in the workspace
- readJSON: Read JSON from files in the workspace.
- readManifest: Read a Jar Manifest
- readMavenPom: Read a maven project file.
- readProperties: Read properties from files in the workspace or text.
- readYaml: Read yaml from files in the workspace or text.
- touch: Create a file (if not already exist) in the workspace, and set the timestamp
- unzip: Extract Zip file
- writeJSON: Write JSON to a file in the workspace.
- writeMavenPom: Write a maven project file.
- zip: Create Zip file
Pipeline: AWS Steps
- awsIdentity: Print the AWS identity
- cfInvalidate: Invalidate given paths in CloudFront distribution
- cfnDelete: Delete CloudFormation stack
- cfnDescribe: Describe outputs of CloudFormation stack
- cfnExports: Describe CloudFormation global exports
- cfnUpdate: Create or Update CloudFormation stack
- cfnValidate: Validate CloudFormation template
- s3Download: Copy file from S3
- s3Upload: Copy file to S3
- snsPublish: Publish notification to SNS
- withAWS: set AWS settings for nested block
Pipeline: Basic Steps
- archive: Archive artifacts
- deleteDir: Recursively delete the current directory from the workspace
- dir: Change current directory
- echo: Print Message
- error: Error signal
- fileExists: Verify if file exists in workspace
- isUnix: Checks if running on a Unix-like node
- mail: Mail
- pwd: Determine current directory
- readFile: Read file from workspace
- retry: Retry the body up to N times
- sleep: Sleep
- stash: Stash some files to be used later in the build
- timeout: Enforce time limit
- tool: Use a tool from a predefined Tool Installation
- unstash: Restore files previously stashed
- waitUntil: Wait for condition
- withEnv: Set environment variables
- wrap: General Build Wrapper
- writeFile: Write file to workspace
- catchError: Catch error and set build result
- getContext: Get contextual object from internal APIs
- unarchive: Copy archived artifacts into the workspace
- withContext: Use contextual object from internal APIs within a block
Pipeline: Build Step
- build: Build a job
Pipeline: Classpath Steps
- addToClasspath: Add file path to Groovy classPath
Pipeline: Groovy
- load: Evaluate a Groovy source file into the Pipeline script
- parallel: Execute in parallel
Pipeline: Input Step
- input: Wait for interactive input
Pipeline: Milestone Step
- milestone: The milestone step forces all builds to go through in order
Pipeline: Model Definition
- script: Run arbitrary Pipeline script
- validateDeclarativePipeline: Validate a file containing a Declarative Pipeline
- envVarsForTool: Fetches the environment variables for a given tool in a list of 'FOO=bar' strings suitable for the withEnv step.
Pipeline: Multibranch
- properties: Set job properties
- readTrusted: Read trusted file from SCM
- resolveScm: Resolves an SCM from an SCM Source and a list of candidate target branch names
Pipeline: Nodes and Processes
- bat: Windows Batch Script
- node: Allocate node
- sh: Shell Script
- ws: Allocate workspace
Pipeline: SCM Step
- checkout: General SCM
Pipeline: Shared Groovy Libraries
- library: Load a shared library on the fly
- libraryResource: Load a resource file from a shared library
Pipeline: Stage Step
- stage: Stage
PlasticSCM Plugin
- cm: Plastic SCM
Pragprog Plugin
- pragprog: Activate tips from The Pragmatic Programmer
PTC Integrity CM - Jenkins Plugin
- siaddprojectlabel: Integrity SCM Label
- sicheckpoint: Integrity SCM Checkpoint
- sici: Integrity SCM Checkin
Puppet Enterprise Pipeline
- puppetCode: Deploy Puppet Environment Code
- puppetHiera: Set Hiera data.
- puppetJob: Create Puppet Orchestrator Job
- puppetQuery: Query PuppetDB with the Puppet Query Language (PQL)
R Plugin
- r: Execute R script
RocketChat Notifier
- rocketSend: Send RocketChat Message
Run Selector Plugin
- selectRun: Select Run
SaltStack plugin
- salt: Send a message to Salt API
Sauce OnDemand plugin
- sauce: Sauce
- sauceconnect: Sauce Connect
Seapine Surround SCM Plug-in
- sscm: Surround SCM
Slack Notification Plugin
- slackSend: Send Slack Message
SonarQube Scanner for Jenkins
- waitForQualityGate: Wait for SonarQube analysis to be completed and return quality gate status
Splunk Plugin Extension
- sendSplunkConsoleLog: Send console log Splunk
- sendSplunkFile: Forwarding pipeline console log to Splunk
- sendSplunkScript: Send data to Splunk via DSL script
SSH Agent Plugin
- sshagent: SSH Agent
StepCounter Plugin
- stepcounter: Count steps
Subversion Plug-in
- svn: Subversion
Team Concert Plugin
- teamconcert: Team Concert
Timestamper
- timestamps: Timestamps
Version Number Plug-In
- VersionNumber: Determine the correct version number
vSphere Plugin
- vSphere: Invoke an vSphere action, exposing the VM IP under some actions
XebiaLabs XL Deploy Plugin
- xldCreatePackage: Create a deployment package
- xldDeploy: Deploy a package to a environment
- xldPublishPackage: Publish a deployment package to XLDeploy
XebiaLabs XL Release Plugin
- xlrCreateRelease: Create and invoke a XLR release

Improve this page | Page history

The content driving this site is licensed under the Creative Commons Attribution-ShareAlike 4.0 license.

Resources

Events
Documentation
Blog

Solutions

Android
C/C++
Docker
Embedded
GitHub
Java
Continuous Delivery
Python
Ruby

Project

Issue tracker
Wiki
GitHub
Jenkins on Jenkins

Community

Users mailing list
Developers mailing list
Twitter
Reddit