Downloads

LTS Release

LTS (Long-Term Support) releases are chosen every 12 weeks from the stream of regular releases as the stable release for that time period. Learn more…

Weekly Release

A new release is produced weekly to deliver bug fixes and features to users and plugin developers.

2.32.1 .war
Docker FreeBSD Gentoo Mac OS X OpenBSD openSUSE Red Hat/Fedora/CentOS Ubuntu/Debian Windows

Changelog | Upgrade Guide | Past Releases

2.42 .war
Docker FreeBSD Gentoo Mac OS X OpenBSD openSUSE Red Hat/Fedora/CentOS Ubuntu/Debian Windows

Changelog | Past Releases
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
Security
Press
Conduct

Fork us on GitHub

Pipeline Guided Tour

Creating your first Pipeline
Controlling your agents and workspaces
Environment variables
Running multiple steps
Reporting test results and storing artifacts
Cleaning Up and Notifications
Running Parallel Steps
Deployment

Pipeline Resources

Pipeline Steps reference
Declarative Pipeline reference

User Handbook

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

Developers

Writing plugins

Extend Jenkins
Extend Pipeline
Extension points

JavaDoc

Latest
2.32
2.19
2.7
1.651
1.642
1.625
1.609
1.596
1.580
1.565
1.554

Pipeline Steps Reference

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

Office-365-Connector
- office365ConnectorSend: office365ConnectorSend
ansible
- ansiblePlaybook: Invoke an ansible playbook
ansicolor
- ansiColor: Color ANSI Console Output
artifactory
- ArtifactoryGradleBuild: run Artifactory gradle
- ArtifactoryMavenBuild: run Artifactory maven
- 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
bitbucket-build-status-notifier
- bitbucketStatusNotify: Notify a build status to BitBucket.
blackduck-hub
- hub_scan: Black Duck Hub Integration
- hub_scan_failure: Black Duck Hub Failure Conditions (Hub 3.0+)
brakeman
- publishBrakeman: Publish Brakeman reports
codefresh
- codefresh: Run a Codefresh Build
credentials-binding
- withCredentials: Bind credentials to variables
cucumber-slack-notifier
- cucumberSlackSend: Send cucumber notifications to slack
deployment-notification
- awaitDeployment: Awaiting for deployment
docker-slaves
- dockerNode: Allocate a docker node
docker-workflow
- 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
email-ext
- emailext: Extended Email
- emailextrecipients: Extended Email Recipients
external-workspace-manager
- exws: Use external workspace
- exwsAllocate: Allocate external workspace
figlet-buildstep
- figlet: Figlet
gatling
- gatlingArchive: Archive Gatling reports
gerrit-trigger
- setGerritReview: Set Gerrit review
git
- git: Git
github-pullrequest
- 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
- hipchatSend: Send HipChat Message
hp-application-automation-tools-plugin
- 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
htmlpublisher
- publishHTML: Publish HTML reports
http_request
- httpRequest: Perform an HTTP Request and return a response object
integrity-plugin
- siaddprojectlabel: Integrity SCM Label
- sicheckpoint: Integrity SCM Checkpoint
- sici: Integrity SCM Checkin
jira
- jiraComment: JIRA: Add a comment to issue(s)
- jiraIssueSelector: JIRA: Issue selector
- jiraSearch: JIRA: Search issues
jms-messaging
- sendCIMessage: CI Notifier
- waitForCIMessage: CI Subscriber
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-steps
- buildImage: Builds a Docker Image
- pushImage: Pushes a Docker Image
- tagImage: Tags a Docker Image
- withPod: Run build steps in a Pod
kubernetes
- 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
- lock: Lock shared resource
marathon
- marathon: Marathon Deployment
mattermost
- mattermostSend: Send Mattermost message
mock-load-builder
- mockLoad: Mock Load
nexus-artifact-uploader
- nexusArtifactUploader: Nexus Artifact Uploader
openshift-pipeline
- 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
- p4: P4 Groovy (BETA)
- p4cleanup: P4 Cleanup
- p4publish: P4 Publish
- p4sync: P4 Sync
- p4tag: P4 Tag
- p4unshelve: P4 Unshelve
parallel-test-executor
- splitTests: Split Test Runs
pipeline-aws
- awsIdentity: Print the AWS identity
- cfInvalidate: Invalidate given paths in CloudFront distribution
- cfnDelete: Delete CloudFormation stack
- cfnDescribe: Describe outputs of CloudFormation stack
- cfnUpdate: Create or Update CloudFormation stack
- s3Download: Copy file from S3
- s3Upload: Copy file to S3
- snsPublish: Publish notification to SNS
- withAWS: set AWS settings for nested block
pipeline-build-step
- build: Build a job
pipeline-classpath
- addToClasspath: Add file path to Groovy classPath
pipeline-githubnotify-step
- githubNotify: Notifies GitHub of the status of a Pull Request
pipeline-input-step
- input: Wait for interactive input
pipeline-maven
- withMaven: Provide Maven environment
pipeline-milestone-step
- milestone: The milestone step forces all builds to go through in order
pipeline-model-definition
- script: Run arbitrary Pipeline script
- dockerLabel: DockerLabelStep
- envVarsForTool: Fetches the environment variables for a given tool in a list of 'FOO=bar' strings suitable for the withEnv step.
pipeline-stage-step
- stage: Stage
pipeline-utility-steps
- findFiles: Find 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
- writeMavenPom: Write a maven project file.
- zip: Create Zip file
pragprog
- pragprog: Activate tips from The Pragmatic Programmer
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)
rocketchatnotifier
- rocketSend: Send RocketChat Message
run-selector
- selectRun: Select Run
sauce-ondemand
- sauce: Sauce
- sauceconnect: Sauce Connect
slack
- slackSend: Send Slack Message
splunk-devops-extend
- sendSplunkConsoleLog: Send console log Splunk
- sendSplunkFile: Forwarding pipeline console log to Splunk
- sendSplunkScript: Send data to Splunk via DSL script
ssh-agent
- sshagent: SSH Agent
stepcounter
- stepcounter: Count steps
subversion
- svn: Subversion
teamconcert
- teamconcert: Team Concert
timestamper
- timestamps: Timestamps
versionnumber
- VersionNumber: Determine the correct version number
vsphere-cloud
- vSphere: Invoke an vSphere action, exposing the VM IP under some actions
workflow-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
- step: General Build Step
- 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
workflow-cps-global-lib
- libraryResource: Load a resource file from a shared library
workflow-cps
- load: Evaluate a Groovy source file into the Pipeline script
- parallel: Execute in parallel
workflow-durable-task-step
- bat: Windows Batch Script
- node: Allocate node
- sh: Shell Script
- ws: Allocate workspace
workflow-multibranch
- properties: Set job properties
- readTrusted: Read trusted file from SCM
workflow-scm-step
- checkout: General SCM

Resources
Solutions
- Android
- C/C++
- Docker
- Embedded
- GitHub
- Java
- Continuous Delivery
- Python
- Ruby
Project
Community

Improve this page | Page history

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