Jenkins plugin

This topic describes how to configure the XL Release plugin for Jenkins.

Plugin configuration

You can configure the XL Release plugin for Jenkins at the global and job levels.

Global Jenkins configuration

Manage the global Jenkins configuration by navigating to Manage Jenkins > Configure System. You can specify the XL Release server URL and one or more sets of credentials. Different credentials can be used for different jobs.

XL Release plugin - global configuration

Job configuration

In the job configuration page, select Post-build Actions > Add post-build action > Release with XL Release. Enter the template name in the box and select a value from the drop-down list.

Tip: You can type / in front of a folder name to see the subfolders and template names in the specified folder.

XL Release plugin - select a job

After you select the template, click Validate template.

XL Release plugin - validate template

To get information about each setting, click ? located next to the setting.

Using the Jenkinsfile

You can use the Jenkins Pipeline feature with the XL Release plugin for Jenkins. This feature allows you to create a “pipeline as code” in a Jenkinsfile, using the Pipeline DSL. You can then store the Jenkinsfile in a source control repository.

For more information about the Jenkins task in XL Release, see Create a Jenkins task.

Create a Jenkinsfile

To start using Jenkinsfile, create a pipeline job and add the Jenkinsfile content to the Pipeline section of the job configuration.

Additional resources:

Jenkinsfile example

The following Jenkinsfile can be used to build a pipeline and deploy a simple web application to a Tomcat environment configured in XL Release.

node {
stage('Package') {
  xldCreatePackage artifactsPath: 'build/libs', manifestPath: 'deployit-manifest.xml', darPath: '$JOB_NAME-$BUILD_NUMBER.0.dar'
stage('Publish') {
  xldPublishPackage serverCredentials: '<user_name>', darPath: '$JOB_NAME-$BUILD_NUMBER.0.dar'
stage('Deploy') {
  xldDeploy serverCredentials: '<user_name>', environmentId: 'Environments/Dev', packageId: 'Applications/<app_name>/$BUILD_NUMBER.0'
stage('Start XLR Release') {
      xlrCreateRelease serverCredentials: '<user_name>', template: 'Release <app_name>', releasetitle: 'Release for $BUILD_TAG', variables: [[propertyName: 'version', propertyValue: '$BUILD_NUMBER.0']], startRelease: true
- xl-release

Release notes

Version 7.5.4

Bug fixes

XLINT-458 - Fix non-default URL was not picked up when in use. Fix non-unique key when looking up the XLReleaseServerConnector in the HashMap. XLINT-706 - Fix startup performance issues

Version 7.5.3

Bug fixes

XLINT-53 - Fix plugin to allow selecting non text variable Fix override credentials DEPL-11051 - Configure Release jobs of xld-jenkins and xlr-jenkins plugin on jenkins DEPL-10994 - Edit XLR Jenkinsfile help text

Version 7.5.2

Bug fixes

XLINT-458 - Make secondary server available for triggering XLR tasks REL-6772 - Change overrideCredentialId optional

Version 7.5.1


  • REL-6099 - Adding override credentials functionality in Jenkinsfile.

Version 7.5.0


  • REL-5850 - Allow user to override credentials in plugin.

Version 6.1.2


  • REL-4251 - Show deprecation warning in Jenkins XL Release plugin when the version parameter is used

Bug fixes

  • REL-4280 - Variable names set in Jenkins post-build action are overwritten by first variable in list
  • REL-4282 - Jenkins XL Release plugin 6.1.1 does not support Java 7

Version 6.1.1


  • REL-4105 - Rename the version parameter on the xldCreateRelease step to releaseTitle


  • Version 6.1.1 of the plugin is not compatible with Java 7. To use version 6.1.1, you must use Java 8. To use the plugin with Java 7, upgrade the plugin to version 6.1.2.
  • The version parameter is now deprecated.

Version 6.1.0


  • Support Jenkins Pipeline, which allows you to create a “pipeline as code” in a Jenkinsfile that can be checked into source control

Version 6.0.0


  • Support for XL Release 6.0.0 with folders
  • Variable names shown without ${ }

Version 5.0.0


  • REL-3468 - Support Jenkins credentials in XL Release plugin for Jenkins

Note: The Jenkins Credentials Plugin must be installed and enabled in Jenkins.