cd2aea0df6965c97a955da02316cf66ef6f5d841
[simantics/platform.git] / releng / doc / release.html
1 <!DOCTYPE html>\r
2 <html>\r
3 <head>\r
4 <title>release</title>\r
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />\r
6 <style type="text/css">\r
7 /* GitHub stylesheet for MarkdownPad (http://markdownpad.com) */\r
8 /* Author: Nicolas Hery - http://nicolashery.com */\r
9 /* Version: b13fe65ca28d2e568c6ed5d7f06581183df8f2ff */\r
10 /* Source: https://github.com/nicolahery/markdownpad-github */\r
11 \r
12 /* RESET\r
13 =============================================================================*/\r
14 \r
15 html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, ruby, section, summary, time, mark, audio, video {\r
16   margin: 0;\r
17   padding: 0;\r
18   border: 0;\r
19 }\r
20 \r
21 /* BODY\r
22 =============================================================================*/\r
23 \r
24 body {\r
25   font-family: Helvetica, arial, freesans, clean, sans-serif;\r
26   font-size: 14px;\r
27   line-height: 1.6;\r
28   color: #333;\r
29   background-color: #fff;\r
30   padding: 20px;\r
31   max-width: 960px;\r
32   margin: 0 auto;\r
33 }\r
34 \r
35 body>*:first-child {\r
36   margin-top: 0 !important;\r
37 }\r
38 \r
39 body>*:last-child {\r
40   margin-bottom: 0 !important;\r
41 }\r
42 \r
43 /* BLOCKS\r
44 =============================================================================*/\r
45 \r
46 p, blockquote, ul, ol, dl, table, pre {\r
47   margin: 15px 0;\r
48 }\r
49 \r
50 /* HEADERS\r
51 =============================================================================*/\r
52 \r
53 h1, h2, h3, h4, h5, h6 {\r
54   margin: 20px 0 10px;\r
55   padding: 0;\r
56   font-weight: bold;\r
57   -webkit-font-smoothing: antialiased;\r
58 }\r
59 \r
60 h1 tt, h1 code, h2 tt, h2 code, h3 tt, h3 code, h4 tt, h4 code, h5 tt, h5 code, h6 tt, h6 code {\r
61   font-size: inherit;\r
62 }\r
63 \r
64 h1 {\r
65   font-size: 28px;\r
66   color: #000;\r
67 }\r
68 \r
69 h2 {\r
70   font-size: 24px;\r
71   border-bottom: 1px solid #ccc;\r
72   color: #000;\r
73 }\r
74 \r
75 h3 {\r
76   font-size: 18px;\r
77 }\r
78 \r
79 h4 {\r
80   font-size: 16px;\r
81 }\r
82 \r
83 h5 {\r
84   font-size: 14px;\r
85 }\r
86 \r
87 h6 {\r
88   color: #777;\r
89   font-size: 14px;\r
90 }\r
91 \r
92 body>h2:first-child, body>h1:first-child, body>h1:first-child+h2, body>h3:first-child, body>h4:first-child, body>h5:first-child, body>h6:first-child {\r
93   margin-top: 0;\r
94   padding-top: 0;\r
95 }\r
96 \r
97 a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4, a:first-child h5, a:first-child h6 {\r
98   margin-top: 0;\r
99   padding-top: 0;\r
100 }\r
101 \r
102 h1+p, h2+p, h3+p, h4+p, h5+p, h6+p {\r
103   margin-top: 10px;\r
104 }\r
105 \r
106 /* LINKS\r
107 =============================================================================*/\r
108 \r
109 a {\r
110   color: #4183C4;\r
111   text-decoration: none;\r
112 }\r
113 \r
114 a:hover {\r
115   text-decoration: underline;\r
116 }\r
117 \r
118 /* LISTS\r
119 =============================================================================*/\r
120 \r
121 ul, ol {\r
122   padding-left: 30px;\r
123 }\r
124 \r
125 ul li > :first-child, \r
126 ol li > :first-child, \r
127 ul li ul:first-of-type, \r
128 ol li ol:first-of-type, \r
129 ul li ol:first-of-type, \r
130 ol li ul:first-of-type {\r
131   margin-top: 0px;\r
132 }\r
133 \r
134 ul ul, ul ol, ol ol, ol ul {\r
135   margin-bottom: 0;\r
136 }\r
137 \r
138 dl {\r
139   padding: 0;\r
140 }\r
141 \r
142 dl dt {\r
143   font-size: 14px;\r
144   font-weight: bold;\r
145   font-style: italic;\r
146   padding: 0;\r
147   margin: 15px 0 5px;\r
148 }\r
149 \r
150 dl dt:first-child {\r
151   padding: 0;\r
152 }\r
153 \r
154 dl dt>:first-child {\r
155   margin-top: 0px;\r
156 }\r
157 \r
158 dl dt>:last-child {\r
159   margin-bottom: 0px;\r
160 }\r
161 \r
162 dl dd {\r
163   margin: 0 0 15px;\r
164   padding: 0 15px;\r
165 }\r
166 \r
167 dl dd>:first-child {\r
168   margin-top: 0px;\r
169 }\r
170 \r
171 dl dd>:last-child {\r
172   margin-bottom: 0px;\r
173 }\r
174 \r
175 /* CODE\r
176 =============================================================================*/\r
177 \r
178 pre, code, tt {\r
179   font-size: 12px;\r
180   font-family: Consolas, "Liberation Mono", Courier, monospace;\r
181 }\r
182 \r
183 code, tt {\r
184   margin: 0 0px;\r
185   padding: 0px 0px;\r
186   white-space: nowrap;\r
187   border: 1px solid #eaeaea;\r
188   background-color: #f8f8f8;\r
189   border-radius: 3px;\r
190 }\r
191 \r
192 pre>code {\r
193   margin: 0;\r
194   padding: 0;\r
195   white-space: pre;\r
196   border: none;\r
197   background: transparent;\r
198 }\r
199 \r
200 pre {\r
201   background-color: #f8f8f8;\r
202   border: 1px solid #ccc;\r
203   font-size: 13px;\r
204   line-height: 19px;\r
205   overflow: auto;\r
206   padding: 6px 10px;\r
207   border-radius: 3px;\r
208 }\r
209 \r
210 pre code, pre tt {\r
211   background-color: transparent;\r
212   border: none;\r
213 }\r
214 \r
215 kbd {\r
216     -moz-border-bottom-colors: none;\r
217     -moz-border-left-colors: none;\r
218     -moz-border-right-colors: none;\r
219     -moz-border-top-colors: none;\r
220     background-color: #DDDDDD;\r
221     background-image: linear-gradient(#F1F1F1, #DDDDDD);\r
222     background-repeat: repeat-x;\r
223     border-color: #DDDDDD #CCCCCC #CCCCCC #DDDDDD;\r
224     border-image: none;\r
225     border-radius: 2px 2px 2px 2px;\r
226     border-style: solid;\r
227     border-width: 1px;\r
228     font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;\r
229     line-height: 10px;\r
230     padding: 1px 4px;\r
231 }\r
232 \r
233 /* QUOTES\r
234 =============================================================================*/\r
235 \r
236 blockquote {\r
237   border-left: 4px solid #DDD;\r
238   padding: 0 15px;\r
239   color: #777;\r
240 }\r
241 \r
242 blockquote>:first-child {\r
243   margin-top: 0px;\r
244 }\r
245 \r
246 blockquote>:last-child {\r
247   margin-bottom: 0px;\r
248 }\r
249 \r
250 /* HORIZONTAL RULES\r
251 =============================================================================*/\r
252 \r
253 hr {\r
254   clear: both;\r
255   margin: 15px 0;\r
256   height: 0px;\r
257   overflow: hidden;\r
258   border: none;\r
259   background: transparent;\r
260   border-bottom: 4px solid #ddd;\r
261   padding: 0;\r
262 }\r
263 \r
264 /* TABLES\r
265 =============================================================================*/\r
266 \r
267 table th {\r
268   font-weight: bold;\r
269 }\r
270 \r
271 table th, table td {\r
272   border: 1px solid #ccc;\r
273   padding: 6px 13px;\r
274 }\r
275 \r
276 table tr {\r
277   border-top: 1px solid #ccc;\r
278   background-color: #fff;\r
279 }\r
280 \r
281 table tr:nth-child(2n) {\r
282   background-color: #f8f8f8;\r
283 }\r
284 \r
285 /* IMAGES\r
286 =============================================================================*/\r
287 \r
288 img {\r
289   max-width: 100%\r
290 }\r
291 </style>\r
292 </head>\r
293 <body>\r
294 <h1>Definition of Done for Simantics Platform Releases</h1>\r
295 <ol>\r
296 <li>The <code>simantics/platform</code> and <code>simantics/third-party</code> Git repositories have a branch <code>release/x.y.z[.w]</code> and tag <code>x.y.z[.w]</code>.</li>\r
297 <li><a href="https://www.simantics.org/redmine/projects/simantics-platform/wiki/ChangeLog">A change log entry</a> is compiled from the issues in this release and made available to the general public separately for the platform and for the open products included in the release train.</li>\r
298 <li><a href="http://dev.simantics.org/index.php/Roadmap">Roadmap</a> is up-to-date.</li>\r
299 <li><a href="http://dev.simantics.org/index.php/Tutorials">Tutorials</a> are up-to-date and coherent with the platform.</li>\r
300 <li>For all new major/minor releases, Wiki documentation is backed up (cloned).</li>\r
301 </ol>\r
302 <hr />\r
303 <h1>Simantics Platform Release Process</h1>\r
304 <ul>\r
305 <li>Create <code>release/x.y.z[.w]</code> release stabilisation branch</li>\r
306 <li>Repeat until stable:\r
307 <ul>\r
308 <li>Develop, test and document components and test products</li>\r
309 </ul>\r
310 </li>\r
311 <li>Tag the release in repository</li>\r
312 <li>Backup documentation wiki databases</li>\r
313 <li>Build and publish SDK package with and without sources\r
314 <ul>\r
315 <li>Does not really require any work</li>\r
316 </ul>\r
317 </li>\r
318 <li>Build Simantics open source products and plug-in components which are a part of the release train</li>\r
319 <li>Update websites to reflect the new release</li>\r
320 </ul>\r
321 <hr />\r
322 <h1>Released Plug-in Components and Products</h1>\r
323 <p>There are both plug-in components and products that are part of the <em>Simantics Release Train</em> that shall be released simultaneously to a major or minor Simantics release.</p>\r
324 <p>Plug-in components are installable features that are deployed online as P2 repositories for general availability. Products are deployed as ZIP files and made available online in designated locations on simantics.org.</p>\r
325 <p>Plug-in components that are part of the release train:</p>\r
326 <ul>\r
327 <li>Simupedia - <a href="https://www.simantics.org:8088/r/gitweb?p=members/simupedia.git;a=summary">members/simupedia.git</a></li>\r
328 <li>FMIL - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/fmil.git;a=summary">simantics/fmil.git</a></li>\r
329 <li>FMI Studio - <a href="https://www.simantics.org:8088/r/gitweb?p=members/fmi.git;a=summary">members/fmi.git</a></li>\r
330 <li>Interoperability components - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/interop.git;a=summary">simantics/interop.git</a></li>\r
331 <li>Simantics R binding - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/r.git;a=summary">simantics/r.git</a></li>\r
332 <li>Matlab SCL binding - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/matlab.git;a=summary">simantics/matlab.git</a></li>\r
333 <li>Python SCL binding - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/python.git;a=summary">simantics/python.git</a></li>\r
334 <li>Simantics System Dynamics - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/sysdyn.git;a=summary">simantics/sysdyn.git</a></li>\r
335 <li>Simantics District modelling components - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/district.git;a=summary">simantics/district.git</a></li>\r
336 </ul>\r
337 <p>Products that are part of the release train:</p>\r
338 <ul>\r
339 <li>Simantics Desktop</li>\r
340 <li>Simantics System Dynamics Tool\r
341 <ul>\r
342 <li>This is Simantics Desktop with Simantics System Dynamics Tool features installed</li>\r
343 </ul>\r
344 </li>\r
345 </ul>\r
346 <p>For simplicity, each of these components are versioned accoring to platform versioning, i.e. for Platform SDK 1.26.0 there will be Simantics Desktop 1.26.0, Sysdyn 1.26.0, and so on.</p>\r
347 <hr />\r
348 <h1>Release Schedule</h1>\r
349 <ul>\r
350 <li>Releases are branched 4 weeks before the set release date.</li>\r
351 <li>During this time no more new features are allowed in the release branch and the existing work shall be stabilized. Work must be focused on bug fixes and documentation.</li>\r
352 <li>Source code changes to release branches are forbidden in the last 2 weeks. Documentation-only changes are still allowed. However, if critical show-stopper problems surface during that time, the changes must be done. After that the release engineering team must decide whether to stick to the original release schedule or whether to delay the release.</li>\r
353 </ul>\r
354 <hr />\r
355 <h1>Simantics Platform Release - Step by Step</h1>\r
356 <h2>Create release branch from selected commit</h2>\r
357 <p>When release stabilisation starts, branch <code>simantics/platform</code> and <code>simantics/third-party</code> repositories:</p>\r
358 <pre><code>git clone ssh://&lt;user&gt;@www.simantics.org:29418/simantics/platform.git\r
359 cd platform\r
360 git branch release/x.y.z[.w] &lt;commit&gt;\r
361 git push origin release/x.y.z[.w]\r
362 \r
363 git clone ssh://&lt;user&gt;@www.simantics.org:29418/simantics/third-party.git\r
364 cd third-party\r
365 git branch release/x.y.z[.w] &lt;commit&gt;\r
366 git push origin release/x.y.z[.w]\r
367 </code></pre>\r
368 <p>When creating major/minor releases <code>&lt;commit&gt;</code> is usually a commit in the <code>master</code> branch.\r
369 With service releases, branch from an existing <code>release/*</code> branch instead.</p>\r
370 <h2>Prepare release branch for use</h2>\r
371 <p>In release 1.31.0 Simantics started using uses the wonderful tool from Obeo (<a href="https://github.com/mbarbero/fr.obeo.releng.targetplatform">https://github.com/mbarbero/fr.obeo.releng.targetplatform</a>) to generate <code>.target</code> files from <code>.tpd</code> files which allow much simpler specification of the target contents and also composition of .tpd files via inclusion.</p>\r
372 <p>In the following steps, it is recommended to ensure every <code>.target</code> file is up-to-date by regenerating them from <code>.tpd</code> files. While doing so, take care to use up-to-date online contents to perform the generation.</p>\r
373 <h3>Prepare <code>.tpd</code> files</h3>\r
374 <ol>\r
375 <li>\r
376 <p>Retrieve release branch of the platform repository</p>\r
377 <pre><code>git clone ssh://&lt;user&gt;@www.simantics.org:29418/simantics/platform.git\r
378 cd platform\r
379 git branch release/x.y.z[.w] remotes/origin/release/x.y.z[.w]\r
380 git checkout release/x.y.z[.w]\r
381 </code></pre>\r
382 </li>\r
383 <li>\r
384 <p>Edit all target platform files in <code>releng/org.simantics.sdk.build.targetdefinition/</code>, i.e.</p>\r
385 <ul>\r
386 <li><code>org.simantics.sdk.build.targetdefinition.tpd</code></li>\r
387 <li><code>simantics.tpd</code></li>\r
388 </ul>\r
389 <p>Replace the following rows in both mentioned files:</p>\r
390 <pre><code>location &quot;http://www.simantics.org/download/master/external-components/maven&quot; {\r
391 location &quot;http://www.simantics.org/download/master/external-components/manual&quot; {\r
392 include &quot;http://www.simantics.org/download/master/org.simantics.sdk.build.targetdefinition.tpd&quot;\r
393 location &quot;http://www.simantics.org/download/master/sdk&quot; {\r
394 </code></pre>\r
395 <p>with</p>\r
396 <pre><code>location &quot;http://www.simantics.org/download/release/x.y.z[.w]/maven&quot; {\r
397 location &quot;http://www.simantics.org/download/release/x.y.z[.w]/manual&quot; {\r
398 include &quot;http://www.simantics.org/download/release/x.y.z[.w]/org.simantics.sdk.build.targetdefinition.tpd&quot;\r
399 location &quot;http://www.simantics.org/download/release/x.y.z[.w]/sdk&quot; {\r
400 </code></pre>\r
401 </li>\r
402 <li>\r
403 <p>Edit version number of <code>org.simantics.sdk</code> feature in <code>features/org.simantics.sdk.feature/feature.xml</code> to <code>x.y.z[.w]</code>.</p>\r
404 <pre><code>&lt;feature\r
405       id=&quot;org.simantics.sdk&quot;\r
406       label=&quot;Simantics SDK&quot;\r
407       version=&quot;x.y.z&quot;\r
408       provider-name=&quot;VTT Technical Research Centre of Finland&quot;&gt;\r
409 </code></pre>\r
410 <p>An example of these changes can be seen in <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/platform.git;a=commit;h=bab5c9bd68277c76dc5c20bc7a60a9896cbd1540">gitweb</a>.</p>\r
411 </li>\r
412 <li>\r
413 <p>Ensure that Redmine has a release engineering issue for the branched release, such as <a href="https://www.simantics.org/redmine/issues/7263">Simantics 1.30.0 release engineering</a>. Make a copy of the previous release issue to create the new one. Include link to original issue while copying.</p>\r
414 </li>\r
415 <li>\r
416 <p>Commit the changes made</p>\r
417 <pre><code> git commit -a\r
418 </code></pre>\r
419 <p>with the commit message</p>\r
420 <pre><code> Configured release/x.y.z[.w] branch for SDK builds.\r
421 \r
422  refs #xxxx\r
423 </code></pre>\r
424 <p>where <code>#xxxx</code> is the number of the x.y.z[.w] release engineering issue and push them to remote</p>\r
425 <pre><code> git push origin release/x.y.z[.w]\r
426 </code></pre>\r
427 </li>\r
428 <li>\r
429 <p>If you are branching from <code>master</code>, bump the revision of master right now to start the next release cycle in master.\r
430 An example of these changes can be seen in <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/platform.git;a=commitdiff;h=ae93c9930c6345c32219e6845b9e72e9d9d2d28c">gitweb</a>.</p>\r
431 <p>Commit the changes with the following commit message</p>\r
432 <pre><code>Bumped master target and org.simantics.sdk feature versions to x.y.z[.w].\r
433 \r
434 refs #yyyy\r
435 </code></pre>\r
436 <p>where <code>#yyyy</code> is the number of the next release's release engineering issue.</p>\r
437 </li>\r
438 </ol>\r
439 <h3>Initialize release branch distribution web site</h3>\r
440 <ul>\r
441 <li>Run <a href="https://www.simantics.org/jenkins/job/SDK/job/Deploy%20External%20Components%20to%20Web/">SDK/Deploy External Components to Web</a> build with parameters:\r
442 <ul>\r
443 <li><strong>GERRIT_REFNAME:</strong> <code>release/x.y.z[.w]</code></li>\r
444 <li><strong>PUBLISH_ARTIFACTS:</strong> <code>true</code></li>\r
445 </ul>\r
446 </li>\r
447 <li>Run the <a href="https://www.simantics.org/jenkins/job/SDK/job/Simantics%20SDK/">SDK/Simantics SDK</a> build with parameters:\r
448 <ul>\r
449 <li><strong>GERRIT_REFNAME:</strong> <code>release/x.y.z[.w]</code></li>\r
450 <li><strong>PUBLISH_ARTIFACTS:</strong> <code>true</code></li>\r
451 </ul>\r
452 </li>\r
453 </ul>\r
454 <p>Running these two builds will ensure that both the external components required to build the SDK and the Simantics SDK for the new release branch are published online at <code>http://www.simantics.org/download/release/x.y.z[.w]/</code>.</p>\r
455 <p>After this, whenever changes are pushed/merged to <code>release/x.y.z[.w]</code> branch in Gerrit, new <strong>SDK/Simantics SDK</strong> builds are triggered automatically and they will publish the results at the same location online.</p>\r
456 <p>This means that one does not have to do any tricks after this to build and publish the SDK as a P2 repository online. It is an automated process that is performed by the <a href="https://www.simantics.org/jenkins/job/SDK/job/Simantics%20SDK/">SDK/Simantics SDK</a> Jenkins job.</p>\r
457 <h3>Update <code>.target</code> files</h3>\r
458 <p>Lastly, we want to change the <code>.target</code> files to point to the correct P2 repository locations. This happens by opening the previously edited <code>.tpd</code> files in Obeo's editor and regenerating the <code>.target</code> files by pressing Alt+R.</p>\r
459 <p>Push the changed files to remote again with commit message:</p>\r
460 <pre><code>Configured release/x.y.z[.w] branch .target files.\r
461 \r
462 refs #xxxx\r
463 </code></pre>\r
464 <h3>Test Release Train build</h3>\r
465 <p>Trigger an execution of the <a href="https://www.simantics.org/jenkins/job/simantics-release-train/">simantics-release-train</a> Jenkins job with parameters</p>\r
466 <ul>\r
467 <li>GERRIT_REFNAME: <code>release/x.y.z[.w]</code></li>\r
468 <li>PUBLISH_ARTIFACTS: <code>true</code></li>\r
469 </ul>\r
470 <p>to ensure that all components of the release train build fine and to publish first versions of P2 repositories of everything online.</p>\r
471 <h2>Review documentation</h2>\r
472 <p>Documentation to review:</p>\r
473 <ul>\r
474 <li><a href="http://dev.simantics.org/">Developer wiki</a></li>\r
475 <li><a href="https://www.simantics.org/end_user_wiki">End-user wiki</a></li>\r
476 <li><a href="https://www.simantics.org/members">Member wiki</a></li>\r
477 </ul>\r
478 <p>For each wiki page:</p>\r
479 <ul>\r
480 <li>Read through and get authors to fix found problems, such as TODOs or invalid information.</li>\r
481 </ul>\r
482 <h2>Review tutorials</h2>\r
483 <ul>\r
484 <li>\r
485 <p>Ensure tutorial wiki documentation at http://dev.simantics.org/index.php/Tutorials is up-to-date with the released platform</p>\r
486 </li>\r
487 <li>\r
488 <p>Ensure tutorial projects and product build properly</p>\r
489 </li>\r
490 <li>\r
491 <p>com.acme.movie</p>\r
492 <ul>\r
493 <li>Build with Buckminster, com.acme.movie.product.site.feature</li>\r
494 </ul>\r
495 </li>\r
496 </ul>\r
497 <h2>Tag release/* branches</h2>\r
498 <p>When the release branches are ready for the release, tag them with the tag <code>vx.y.z[.w]</code>:</p>\r
499 <pre><code>git clone ssh://&lt;user&gt;@www.simantics.org:29418/simantics/platform.git\r
500 cd platform\r
501 git checkout release/x.y.z[.w]\r
502 git tag vx.y.z[.w] -m &quot;Simantics x.y.z[.w] simultaneous release&quot;\r
503 git push origin --tags\r
504 \r
505 git clone ssh://&lt;user&gt;@www.simantics.org:29418/simantics/third-party.git\r
506 cd third-party\r
507 git checkout release/x.y.z[.w]\r
508 git tag vx.y.z[.w] -m &quot;Simantics x.y.z[.w] simultaneous release&quot;\r
509 git push origin --tags\r
510 </code></pre>\r
511 <blockquote>\r
512 <p>Note The -m argument must be supplied to create an <a href="https://git-scm.com/book/en/v2/Git-Basics-Tagging">annotated tag</a>.\r
513 Only annotated or signed tags can be pushed to Gerrit.</p>\r
514 </blockquote>\r
515 <h2>Backup documentation wiki databases</h2>\r
516 <p>This step is only necessary for major/minor releases, not for service releases.</p>\r
517 <p>The wiki databases to be backed up are:</p>\r
518 <ul>\r
519 <li><a href="http://dev.simantics.org/">Developer wiki</a></li>\r
520 <li><a href="https://www.simantics.org/end_user_wiki">End-user wiki</a></li>\r
521 </ul>\r
522 <p>These are MediaWiki installations. The only sane way to &quot;tag&quot; the documentation\r
523 is to back up the mysql database backing the wiki. Should the wiki be required\r
524 at a later time for some reason, we'll put the documentation up then in a\r
525 separate Mediawiki installation.</p>\r
526 <ol>\r
527 <li>Dump documentation wiki databases using <a href="./dump-wikis.sh">dump-wikis.sh</a> script.</li>\r
528 <li>Put the generated backup x.y.z.tar.gz at /var/backup/simantics-releases/x.y.z/wiki/</li>\r
529 </ol>\r
530 <h2>Compile change log entry</h2>\r
531 <ul>\r
532 <li>Edit the <a href="https://www.simantics.org/redmine/projects/simantics-platform/wiki/ChangeLog">main page</a> and add a a link for release x.y.z[.w].</li>\r
533 <li>Open the change log page of the previous release, e.g. <a href="https://www.simantics.org/redmine/projects/simantics-platform/wiki/Simantics_1250">1.25.0</a></li>\r
534 <li>Open the new link in another browser/tab to start editing the new wiki page</li>\r
535 <li>Edit the previous release's page and copy its wiki source contents over to the new release's page.</li>\r
536 <li>Fix the content to match the new release:\r
537 <ul>\r
538 <li>Remove the issue content of the previous release</li>\r
539 <li>Fix release number, release date, release branch link and the link to all issues closed for the release\r
540 <ul>\r
541 <li>Save new public issue query that lists all issues closed for the release by <a href="https://www.simantics.org/redmine/projects/simantics-platform/issues?query_id=122">starting from the previous release's query</a></li>\r
542 </ul>\r
543 </li>\r
544 <li>Add filter to query: <strong>Release Notes: Any</strong> to only show issues that have some content in their Release Notes field</li>\r
545 <li>Export closed issue list as CSV with selected columns only. Open the resulting CSV file in Excel.</li>\r
546 <li>Use <strong>Data -&gt; Text to Columns</strong> with tab column separation to columnize the result</li>\r
547 <li>Format the list as a table so that there is only one issue / row</li>\r
548 <li>Remove all other columns besides: Issue #, Tracker, Release Notes</li>\r
549 <li>Format the data into a Textile table:\r
550 <ul>\r
551 <li>Copy to table contents as text into <a href="http://www.pspad.com/">PSPad</a></li>\r
552 <li>Replace (CTRL+H) tabs (<code>\t</code>) with <code>|</code> with <code>Regular Expressions</code> selection checked</li>\r
553 <li>Use <strong>Insert Text Into Lines..</strong> (ALT-I) to fix line beginnings and ends:\r
554 <ul>\r
555 <li>Text:\r
556 <ul>\r
557 <li>At Lines Begin: <code>|#</code></li>\r
558 <li>At Lines End: <code>|</code></li>\r
559 </ul>\r
560 </li>\r
561 </ul>\r
562 </li>\r
563 </ul>\r
564 </li>\r
565 <li>Copy the resulting textile table over to the change log page</li>\r
566 </ul>\r
567 </li>\r
568 <li>Highlight major issues in the list by changing the text background color of the <strong>Type</strong> column:\r
569 <ul>\r
570 <li><code>%{background: lightsalmon}Major Bug%</code></li>\r
571 <li><code>%{background: lightgreen}Major Feature%</code></li>\r
572 <li><code>%{background: lightgreen}Major Enhancement%</code></li>\r
573 </ul>\r
574 </li>\r
575 </ul>\r
576 <h2>Disseminate information about the release</h2>\r
577 <ul>\r
578 <li><a href="http://dev.simantics.org">Developer Wiki</a>: Update roadmap at <a href="http://dev.simantics.org/index.php/Roadmap">http://dev.simantics.org/index.php/Roadmap</a></li>\r
579 <li><a href="https://www.simantics.org/redmine/">Redmine</a>: Post news on the developer/user-visible changes here</li>\r
580 <li><a href="https://www.simantics.org">simantics.org</a>: Post news on the release and a link to the redmine post</li>\r
581 <li><a href="https://www.simantics.org/members/">Members Wiki</a>: Update frame plan to reflect the realized dates and link to Redmine news</li>\r
582 <li><a href="mailto:simantics-developers@simantics.org">mailto:simantics-developers@simantics.org</a> Send &quot;newsletter&quot; to `simantics-developers@simantics.org:</li>\r
583 </ul>\r
584 <p><strong>Newsletter template:</strong></p>\r
585 <pre><code>Hello everyone,\r
586 \r
587 Simantics release x.y.z[.w] has been released. Head over to\r
588 https://www.simantics.org/redmine/news/&lt;news number&gt;\r
589 for the release news.\r
590 \r
591 Best regards,\r
592 Simantics Release Engineering Team\r
593 </code></pre>\r
594 <p><strong>Redmine news template:</strong></p>\r
595 <pre><code>Title: Simantics x.y.z[.w] released\r
596 \r
597 Simantics x.y.z[.w] was released on &lt;date&gt;.\r
598 Please find change log at: [[simantics-platform:Simantics_xyzw|Simantics x.y.z[.w]]]\r
599 \r
600 Insert some general thoughts on the release...\r
601 </code></pre>\r
602 <hr />\r
603 <h1>TODO</h1>\r
604 <ul>\r
605 <li>Incorporate tutorial code in the platform repository as a separate folder to allow platform builds to directly ensure that the tutorial code still builds OK</li>\r
606 </ul>\r
607 \r
608 </body>\r
609 </html>\r
610 <!-- This document was created with MarkdownPad, the Markdown editor for Windows (http://markdownpad.com) -->\r