Release and Triggers Settings
In this topic, you will learn how to configure the releases, workflows, and triggers settings.
Note: The System Settings screen is reorganized to make the navigation more user-friendly. The settings are now grouped by theme, to easily locate and access the features.
Navigate to the upper-right corner of the screen, click > System Settings > Releases and Triggers.
Note: The General settings page is available only for Administrators, who have the Admin global permission.
Archive and Clean-up Releases and Workflows
Tip The text fields on this screen have increment and decrement buttons to increase or decrease the values respectively. The Time drop-down list allows you to select the values in hours, days, weeks, or years.
- In the Archive executions older than field set a value in hours or days. This value defines the number of hours or days after which the releases or workflow executions that are completed or aborted will be archived. The default value is
30
days. - Select the Allow executions to skip archiving checkbox to exempt the releases and workflows from being archived. When this checkbox is enabled, the Archive release checkbox shows up on the Properties sub-page template and releases.
Note: By marking a release to skip archive, the completed or aborted release is deleted instead of being moved to the archive database. This is useful for transient releases, which has no business value and are to be excluded from reporting and statistics.
- Select the Enable automatic abort of stale executions checkbox to automatically abort stale releases and workflow executions. Selecting this checkbox, enables the Abort long running executions older than field.
- In the Abort long running executions older than field set a value in days or weeks. This value defines the number of days or weeks after which the releases or workflow executions that are incomplete will be aborted. The default value is
90
days. - Select the Enable purging of archived executions checkbox to automatically purge archived releases and workflow executions. Selecting this checkbox, opens a confirmation modal. Click Confirm to delete the archived releases and workflows executions after the retention period. Also, this enables the Maximum archive retention period field.
- In the Maximum archive retention period field set a value in days or years. This value defines the maximum number of days or years you can archive the releases or workflow executions.
- By default, the Export execution data when purging checkbox and Export path field are disabled. These are enabled once the click Confirm in the confirmation modal.
To learn more, see How archiving works.
Release reports related to finished releases only use data from the archive database. Therefore, if you configure a very long period before releases are archived, then your reports will not be up-to-date. Also, having a large number of releases that are not archived negatively affects performance. For more information about the configuration of the database, see Configure the archive database.
Before the releases are removed from the database, their content will automatically be exported to the file system location configured in the Export path field. The exported releases will be organized in subdirectories by their end date so each zip will be in the purged/<year>/<month>/<day>/<release-id>.zip
format.
Here's an example for the contents of a purged release zip file:
release.json
activity-log.json
attachments/<attachment-id>/<attachment-file-name>
Limits in Release
Learn how to configure folder depth, trigger interval, and so on.
By default, the Enable limits checkbox is selected.
- Limit the maximum folders to be created
- Set the time interval between two subsequent trigger executions
- Limit the number of times a trigger can fail
These settings help to improve the performance of various features in the Release system.
Limit Folder Depth in Release
A nested folder structure with more than five or six levels becomes cumbersome to deal with and can adversely impact the performance and lead to the following issues:
- General slowness
- High CPU usage
- CLI tasks become unreliable
- Create release task is not usable
In the Maximum Folder depth field, enter a value to define the number of folders to be created. The default value is 5
.
Note: Administrators can increase the folder depth to more than
5
based on the requirements.
Limit Minimal Trigger Polling Interval
Currently, the minimum polling interval for triggers is 1
second. This causes increased load in Release and other third-party systems. To overcome this performance issue, the minimum polling interval for triggers is changed to 60
seconds.
In the Minimum Trigger interval field, enter a value to define the minimum polling interval value. The default value is 60
seconds.
Limit Triggers Failures
You can set the maximum number of trigger failures that can occur before a trigger is disabled.
In the Consecutive Trigger failures field, enter a value to define the number of times a trigger can fail before its disabled. The default value is 100
.
Furthermore, when a trigger is disabled, a notification is sent to the Administrator.
Trigger Data Purging
You can purge the Release trigger execution data. This execution data will be removed from the database table.
- Select the Enable purging of trigger data checkbox, to purge the trigger execution data. Selecting this checkbox enables the Purge Trigger data older than field.
- In the Purge Trigger data older than field, set a value in hours or days. This value defines the number of hours or days after which the trigger data is deleted. The default value is
30
days.
Whenever, you update a setting on this screen, the Save button is enabled.
- Click Save to save the changes.
- Click Reset to return to the default setting of the screen.