Create Release

When you create a new release you first need to select the pipeline to use. Pipelines can be selected from one of the following pipeline libraries. (Note: When creating a new release from the App page the 'App Pipelines' library is automatically selected):

• Global Pipelines. All global pipelines.

• Group Pipelines. All piplines that belong to the App Group that the selected app belongs to.

• App Pipelines. All app-specific pipelines that have been created for the selected app.

Only users that have been assigned the app role 'App Administrator' or 'App Operator' for an app can create releases.

Release Details

After selecting the pipeline you want to use the manage release page appears.

Release Status

This tile shows status information about this release:

• Current status. The current status of the release. The following are the possible statuses:

  • Scheduled : The release is scheduled for execution.

  • Not started : The release has not yet been submitted to the release scheduler and can still be changed. This is the default status for a new release.

  • Waiting approval : The release is waiting for an approval before it begins execution.

  • Running : The release is currently running.

  • Successful : The release has successfully completed

  • Warning : The release completed but generated warnings.

  • Failed : The release failed to complete successfully.

  • Scheduled : The release is scheduled for execution but has not yet started.

• Last message. The most recent output of the release.

Approvals

If your pipeline contains an approval task, the required approvals (or already given approvals) will be shown in the approvals tile.

Release Configuration

Depending on the pipeline tasks that have been added to your pipeline, the following release configuration tiles may be visible.

Target Environment

• Environment. The target environment for this release. Note: If this has been pre-configured in the pipeline it cannot be changed.

• Configuration. If the selected pipeline has a 'Deploy Configuration' task, select the configuration to be used. Configurations are specific to the environment that you have selected. The list of configurations that are available can be managed from the Configurations tab for each environment in the App page.

Scheduling

• Schedule type. The schedule type used for this release. This is set by the pipeline configuration and cannot be changed. For details on the possible values see the pipeline management page.

• Scheduled for. The date and time when this release is scheduled to be executed.

• Use task scheduling. If you enable this you can select the date and time for each pipeline task to be executed. Note that task scheduling is only available for pipelines with the schedule type 'on demand'.

Restore from Backup

This tile is visible if your pipeline has a restore task.

• Source environment. The environment that contains the backups that you want to restore from. Note that this option is only visible if it has been enabled by the pipeline administrator. The default is to only allow restores from the same environment as the target environment.

• Backup. The backup you want to restore.

• Check for newer backups. If you enable this you can select the date and time for each pipeline task to be executed. Note that task scheduling is only available for pipelines with the schedule type 'on demand'.

Backup Details

This tile is visible if your pipeline has a restore task.

• Backup ID. The unique ID of this backup from your backup repository.

• Created on. When the backup was created.

• Model version. The Mendix model version that was deployed when this backup was created.

• Comment. User or system comment that identifies this backup.

• Status. Technical status of the backup (may be empty). Can be helpful to determine if the backup is complete and ready to be used.

Revision

This tile is visible if your pipeline has a deploy task.

• Use existing package. If selected, the deploy task will use an existing package instead of building a new one. Note: This option will not be visible if the pipeline administrator has configured the pipeline to use a specific branch or revision.

• Package. The package you want to deploy. Note: This option is only visible when 'use existing package' is selected.

• Check for newer packages. If the package you want to use is not visible, use this action to update the list of packages available from your package repository.

• Branch. The source branch for this release. Note: If this has been pre-configured in the pipeline it cannot be changed.

• Revision. The source revision for this release. Note: If this has been pre-configured in the pipeline it cannot be changed. In some cases the revision selected is not the most recent revision in the app repository.

• Check for newer revisions. Use this action to scan your app repository for newer revisions for the selected branch.

Revision Details

This tile is visible if your pipeline has a deploy task.

• Commit message / description. The last commit message for the source revision used by this release, or the description of the selected package.

• Mendix version. The version of Mendix used by the source revision or package used by this release.

Release Notes & Versioning

• Release version. The version number to be used for this release.

• Release notes. The release notes to be used for this release.

Pipeline Tasks

The pipeline tasks section is always visible and shows you the current status of all tasks that will be executed as part of this release.

For each task the current status is displayed as well as the last message that was output by the task. The status of pipeline tasks is automatically updated every 20-60 seconds.

If task scheduling has been enabled for this release, it is possible to set the date and time when each task will be executed. Note: The date and time set is not guaranteed. This setting means that the task will start execution at the selected date and time as long as all previous tasks have completed execution.

If a pipeline task fails additional information may be available from the logs tab.