Valid since:
XL Release 5.0.0

A Create Release task is an automatic task that creates and starts a release based on a configured template.

Create release task details

The options for the Create Release task are:

Option Description
Release title The title to use for the newly created release.
Template The template from which to create a release, or the variable from which the template ID will be derived.
Folder The folder where you want to create the release.
Risk profile The risk profile assigned to the release.
Start release If selected, the release will be started after it is created by this task.
Release tags Tags that will be added in the new release; you can use variables with the placeholder ${...}.
Variables Variables from the template that must be filled in (if applicable).
Created release ID Output property bound to the variable that contains the ID of the created release.

In the release flow editor, Create Release tasks have a green border.

Assigning an automated tasks user

A release that contains a Create Release task must be assigned an automated tasks user who has the Create Release permission on the template that you specify in the Create Release task. This automated tasks user will be copied to the new release that is created by the Create Release task. This means that, if the template that you specify is assigned a different automated tasks user, that user will not be used in the new release.

You assign the automated tasks user in the Run automated tasks as user release property.

Passing the template and its variables dynamically

The template for creating a release can also be assigned through a release variable, by switching the template selector element to variable mode using the toggle button located left of the element.

Template ID selector

In this mode, the selector is populated with global/release variables that can be chosen, and will be used to derive the Template ID when the task runs. It is also possible to create a new variable through the selector by typing the variable name and selecting the create option that is displayed.

When the template selector is in variable mode, and a variable is selected, the Variables option of the Create Release task can do the following things:

  • An Add button is displayed, as it becomes possible to add variables of all types that will be passed to the template, directly on the Create Release task.
  • The values for these can also be passed dynamically, since each variable has a toggle button located to the left and can be switched to variable mode. In this mode, like with template option described previously, the selector is populated with global/release variables that can be chosen, and from which the value to pass to the respective variable will be resolved.

Variables option when template from variable

Using the new release ID

When the new release is created, XL Release stores its unique ID in the Create Release task’s Created release ID output property. If you configure this property to be a variable, then you can use the variable in other tasks. For example, you can use the variable in a Gate task so the initial release will wait at the Gate until the new release is complete.

If you do not save the Created release ID in a variable, then the release will proceed normally, but you will not be able to refer to the created release in other tasks.

The example above shows a task that will create and start a new release based on the “Front office services release template” template. The new release’s title will be “Release front office services 2.1”, and the value of the ${version} template variable will be set to “2.1”. When the “Release front office services 2.1” release is created, XL Release will store its unique ID in the ${frontOfficeServiceReleaseId} variable.

Limiting concurrent releases

To prevent performance issues, XL Release limits the number of concurrently running releases that can be created by Create Release tasks to 100. You can adjust this limit by uncommenting and changing the xlrelease.Release.maxConcurrentReleases property in the XL_RELEASE_SERVER_HOME/conf/deployit-defaults.properties file. You must restart the XL Release server for the change to take effect.