Creating a new Release

Last modified by Danniar Firdausy on 2024/09/05 10:41

In this microlearning, we’ll explore how to create and manage releases in eMagiz. Building on your knowledge from previous phases, you’ll learn how to define exactly what needs to be deployed by setting up releases that specify which flow components will run in your environment. We'll cover the steps for creating a new release, adding flows, and managing your releases effectively.

Should you have any questions, please contact academy@emagiz.com.

1. Prerequisites

  • Basic knowledge of the eMagiz platform
  • Completed all microlearnings from Deploy till this specific microlearning
  • Have an environment where you can add releases and that is operational to try out the deployment plan

2. Key concepts

eMagiz provides the capability to manage your deployments effectively so that all your updated flow components as created in the previous ILM phases of eMagiz. In the previous microlearning, you have seen how the flows are deployed across the different eMagiz runtimes. This microlearning defines what exactly needs to be deployed.

When you create a release you create a set/view of all flows that should run on your environment on a specific date and time.

This microlearning centers around creating (and managing) an eMagiz Release.

3. Creating a new Release

Below the steps to create a new release and the options available.

3.1 Creating a Release in TEST

The first step is to create a new release using the New Release button. This allows providing a name for the Release and the type of the revision (Major, Minor, or Patch). Depending on the purpose of the release, the right versioning can be selected. Provide sufficient comments to recognize the objective of the release.

crashcourse-platform-deploy-create-new-release-pic1.png

Once the name is provided, please note the three small circles under the name. These denote in what environment this release is active (black or green color) and quickly looking for the green circle you will find the active release of a specific environment.

3.2 Adding flows to Release

Based on the version selected, and the committed flows from the Create phase, the release content is determined. You have various compare options between releases to understand what exactly has changed between releases to verify if the list of flows created is the good one. You can compare Releases (and to the Create phase) by holding the CRTL button and selecting two releases. The canvas will then highlight the differences in the following manner:

  • Blue: the flow is changed functionally (new version created)
  • Red: a flow in the first Release selected is no longer present compared to the second release selected
  • Green/white: this flow is added compared to the second release selected

crashcourse-platform-deploy-create-new-release-pic4.png

A release may contain flow components from different patterns. In the bottom right, the different patterns are displayed and the steps above can be repeated for every pattern. There are small circles right above the patterns to understand the changes made in these views. They are following the same color indication pattern as above

crashcourse-platform-deploy-create-new-release-pic4.png

Note that the following flows cannot be visually added to a release:

  • JMS
  • Entry gate

3.3 Set Release as active

Once the release is created, there is an asterisk before the name. This means that the release is not active yet. With the three-dots-option button right next to the name of the release, you have various options for that release. Select the option set as active to make this the release that the deployment plan will use to deploy the updated, new, and changed flows.

crashcourse-platform-deploy-create-new-release-pic2.png

4. Key takeaways

  • The Release defines what is to be deployed on a specific environment, as compared to the Deployment plan that determines what is to be deployed
  • Use proper naming and clean your old releases regularly. Non-active releases only can be deleted
  • When you create a release you create a set/view of all flows that should run on your environment on a specific date and time

5. Suggested Additional Readings