Skip to Content
Version 1.1 by eMagiz on 2022/05/10 11:22
Show last authors
1 {{html wiki="true"}}
2 <div class="ez-academy">
3 <div class="ez-academy_body">
4
5 <div class="doc">
6
7
8
9 = Promote flows to deploy =
10
11 A crucial part of proper release management is a clear distinction between what is (perceived to be) finished and what is still under development.
12 To help you in making that decision, eMagiz gives you the possibility to temporarily save your work, and when you (think you) are finished creating a definitive version that will be promoted to Deploy
13
14 In this microlearning, we will zoom in on this process to educate you on how you can and should use this functionality.
15
16 Should you have any questions, please contact academy@emagiz.com.
17
18 * Last update: February 5th, 2021
19 * Required reading time: 5 minutes
20
21 == 1. Prerequisites ==
22
23 * Basic knowledge of the eMagiz platform
24
25 == 2. Key concepts ==
26
27 This microlearning focuses on promoting flows to deploy.
28
29 With promoting to deploy we mean: Saving a definitive version of a flow that is (perceived to be) finished by the developer for the flow to become available under Releases
30
31
32
33 == 3. Promote flows to deploy ==
34
35 A crucial part of proper release management is a clear distinction between what is (perceived to be) finished and what is still under development.
36 To help you in making that decision, eMagiz gives you the possibility to temporarily save your work, and when you (think you) are finished creating a definitive version that will be promoted to Deploy
37
38 When you are in the Start Editing Mode you will have to press Stop Editing at some point in time. When you press Stop Editing in the flow you will be presented with the following pop-up
39
40 <p align="center">[[image:crashcourse-platform-create-promote-flows-to-deploy--create-new-version-pop-up.png||]]</p>
41
42 At this point, you have to make a choice. If you are satisfied with your work you press Save and create a new version.
43 If you are unsure of your work or simply need to stop because there is no more time left go for the option Save and continue
44
45 === 3.1 Save and create a new version ===
46
47 When you go for the option Save and create a new version you will see the following pop-up
48
49 <p align="center">[[image:crashcourse-platform-create-promote-flows-to-deploy--save-and-create-new-version-pop-up.png||]]</p>
50
51 Choose whether this was a major, minor, or patch upgrade and give a description of the version that tells you and others what you have changed. Something like this
52
53 <p align="center">[[image:crashcourse-platform-create-promote-flows-to-deploy--save-and-create-new-version-pop-up-filled-in.png||]]</p>
54
55 Press the button Create version and eMagiz will automatically promote this flow version to Deploy where you can use it as part of your Release (more on releases later in this course).
56
57 <p align="center">[[image:crashcourse-platform-create-promote-flows-to-deploy--pop-up-successfully-promoted-to-deploy.png||]]</p>
58
59 === 3.2 Save and continue ===
60
61 When you are not sure that the version you are currently working on is ready for Deploy you can select the other option called Save and continue.
62 When choosing this option eMagiz will automatically create a temporary version of your flow in its current state.
63 You can view who made what (temporary) version when you navigate to the History tab of your flow.
64
65 <p align="center">[[image:crashcourse-platform-create-promote-flows-to-deploy--history-of-flow.png||]]</p>
66
67 This history of the changes in the flow is not only useful for auditing purposes but also helps you identify who you should ask about the latest changes.
68 As you can see the default description of an autosaved version is Autosaved version. You can give such a version a more descriptive name by selecting it and pressing Edit.
69
70 <p align="center">[[image:crashcourse-platform-create-promote-flows-to-deploy--edit-description-auto-saved-version.png||]]</p>
71
72 That action will lead you to the following pop-up. In this pop-up, you can change the description of the autosaved version to something that makes clear what you did.
73
74 <p align="center">[[image:crashcourse-platform-create-promote-flows-to-deploy--edit-description-auto-saved-version-pop-up.png||]]</p>
75
76 Simply press Save when you are done and the description will be changed
77
78 <p align="center">[[image:crashcourse-platform-create-promote-flows-to-deploy--edit-description-auto-saved-version-result.png||]]</p>
79
80 Furthermore, to make it clear to yourself and others the version of the flow will get an asterisk as a suffix the next time you open the flow
81
82 <p align="center">[[image:crashcourse-platform-create-promote-flows-to-deploy--save-and-continue-version-asterisk.png||]]</p>
83
84 === 3.3 Initial promotion ===
85
86 In many cases, there is a link between several flows (i.e. entry and onramp, entry and exit gate, infra, and all other flows). These flows we call the associated flows.
87 The moment you try to promote one of these flows without all others eMagiz will tell you that for an initial promotion you will look for these associated flows
88 and create a new version for them as well for eMagiz to promote them all at once when you press Save and create a new version on the last one of the flows that are associated with each other.
89
90 To indicate to you that such an action is required eMagiz will present you the following pop-up:
91
92 <p align="center">[[image:crashcourse-platform-create-promote-flows-to-deploy--create-version-associated-flows.png||]]</p>
93
94 ===== Practice =====
95
96 == 4. Assignment ==
97
98 The assignment this time consists of several steps:
99
100 * Navigate to Create and open a flow
101 * Press Start Editing
102 * Immediately press Stop Editing and choose the option Save and Continue
103 * Give this autosaved version a description
104 * Press Start Editing again
105 * Immediately press Stop Editing and choose the option Save and Create a new version
106 * Choose the option patch and give a good description
107
108 This assignment can be completed within the (Academy) project that you have created/used in the previous assignment.
109
110 == 5. Key takeaways ==
111
112 * In Create you can choose between the options:
113 * Save and create a new version (promoting the flow to Deploy)
114 * Save and continue (creating a temporary version)
115 * You can change the description of an autosaved version
116 * To get a bundle of associated flows to deploy initially you will have to create a version for each flow within that bundle
117
118
119
120 == 6. Suggested Additional Readings ==
121
122 If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
123
124 == 7. Silent demonstration video ==
125
126 This video demonstrates a working solution and how you can validate whether you have successfully completed the assignment.
127
128 <iframe width="1280" height="720" src="../../vid/microlearning/crashcourse-platform-create-promote-flows-to-deploy.mp4" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
129
130 </div>
131
132 </div>
133 </div>
134
135 {{/html}}