X-Git-Url: https://gerrit.simantics.org/r/gitweb?a=blobdiff_plain;f=releng%2Fdoc%2Frelease.html;h=ebe85ee67cb86e68d53ae6eba18c0f471923dd1f;hb=eae2657463e387cb764e7e5780d5c56f5311c0af;hp=0708ef4c326f5c9a5d057d84ee4dc14591f52ea3;hpb=c6133d637f50045f7827056b604587ab13a2dae9;p=simantics%2Fplatform.git

diff --git a/releng/doc/release.html b/releng/doc/release.html
index 0708ef4c3..ebe85ee67 100644
--- a/releng/doc/release.html
+++ b/releng/doc/release.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
 <head>
-<title>MarkdownPad Document</title>
+<title>release</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <style type="text/css">
 /* GitHub stylesheet for MarkdownPad (http://markdownpad.com) */
@@ -297,8 +297,9 @@ img {
 <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>
 <li><a href="http://dev.simantics.org/index.php/Roadmap">Roadmap</a> is up-to-date.</li>
 <li><a href="http://dev.simantics.org/index.php/Tutorials">Tutorials</a> are up-to-date and coherent with the platform.</li>
-<li>For all new major/minor releases, Wiki documentation is backed up (cloned). This is not necessary for service releases of old release branches.</li>
+<li>For all new major/minor releases, Wiki documentation is backed up (cloned).</li>
 </ol>
+<hr />
 <h1>Simantics Platform Release Process</h1>
 <ul>
 <li>Create <code>release/x.y.z[.w]</code> release stabilisation branch</li>
@@ -308,30 +309,49 @@ img {
 </ul>
 </li>
 <li>Tag the release in repository</li>
-<li>Tag documentation
+<li>Backup documentation wiki databases</li>
+<li>Build and publish SDK package with and without sources
 <ul>
-<li><a href="https://www.simantics.org/wiki">https://www.simantics.org/wiki</a> â <a href="http://www.simantics.org/%3Cversion%3E/wiki">http://www.simantics.org/&lt;version&gt;/wiki</a></li>
+<li>Does not really require any work</li>
 </ul>
 </li>
-<li>Build and publish SDK package with and without sources</li>
-<li>Build Simantics open source products and plug-in components which are a part of the release train
+<li>Build Simantics open source products and plug-in components which are a part of the release train</li>
+<li>Update websites to reflect the new release</li>
+</ul>
+<hr />
+<h1>Released Plug-in Components and Products</h1>
+<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>
+<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>
+<p>Plug-in components that are part of the release train:</p>
 <ul>
-<li>Simantics Sysdyn</li>
-<li>Simantics R</li>
-<li>Simupedia</li>
-<li>FMI Studio</li>
+<li>Simupedia - <a href="https://www.simantics.org:8088/r/gitweb?p=members/simupedia.git;a=summary">members/simupedia.git</a></li>
+<li>FMIL - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/fmil.git;a=summary">simantics/fmil.git</a></li>
+<li>FMI Studio - <a href="https://www.simantics.org:8088/r/gitweb?p=members/fmi.git;a=summary">members/fmi.git</a></li>
+<li>Interoperability components - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/interop.git;a=summary">simantics/interop.git</a></li>
+<li>Simantics R binding - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/r.git;a=summary">simantics/r.git</a></li>
+<li>Matlab SCL binding - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/matlab.git;a=summary">simantics/matlab.git</a></li>
+<li>Python SCL binding - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/python.git;a=summary">simantics/python.git</a></li>
+<li>Simantics System Dynamics - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/sysdyn.git;a=summary">simantics/sysdyn.git</a></li>
+<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>
 </ul>
-</li>
-<li>Update websites to reflect the new release
+<p>Products that are part of the release train:</p>
+<ul>
+<li>Simantics Desktop</li>
+<li>Simantics System Dynamics Tool
 <ul>
-<li><a href="http://dev.simantics.org">dev.simantics.org</a></li>
-<li><a href="https://www.simantics.org/end_user_wiki/">www.simantics.org/end_user_wiki/</a></li>
-<li><a href="https://www.simantics.org/members/">www.simantics.org/members/</a></li>
-<li><a href="https://www.simantics.org">www.simantics.org</a></li>
+<li>This is Simantics Desktop with Simantics System Dynamics Tool features installed</li>
 </ul>
 </li>
 </ul>
-<p>In the following sections each task is described step by step.</p>
+<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>
+<hr />
+<h1>Release Schedule</h1>
+<ul>
+<li>Releases are branched 4 weeks before the set release date.</li>
+<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>
+<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>
+</ul>
+<hr />
 <h1>Simantics Platform Release - Step by Step</h1>
 <h2>Create release branch from selected commit</h2>
 <p>When release stabilisation starts, branch <code>simantics/platform</code> and <code>simantics/third-party</code> repositories:</p>
@@ -348,7 +368,9 @@ git push origin release/x.y.z[.w]
 <p>When creating major/minor releases <code>&lt;commit&gt;</code> is usually a commit in the <code>master</code> branch.
 With service releases, branch from an existing <code>release/*</code> branch instead.</p>
 <h2>Prepare release branch for use</h2>
-<h3>Prepare .target files</h3>
+<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>
+<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>
+<h3>Prepare <code>.tpd</code> files</h3>
 <ol>
 <li>
 <p>Retrieve release branch of the platform repository</p>
@@ -359,28 +381,60 @@ git checkout release/x.y.z[.w]
 </code></pre>
 </li>
 <li>
-<p>Edit all target platform files in  <code>releng/org.simantics.sdk.build.targetdefinition/</code>, i.e.</p>
+<p>Edit all target platform files in <code>releng/org.simantics.sdk.build.targetdefinition/</code>, i.e.</p>
 <ul>
-<li><code>simantics.target</code></li>
-<li><code>org.simantics.sdk.build.targetdefinition.target</code></li>
-<li><code>org.simantics.sdk.build.targetdefinition-semantum.target</code></li>
+<li><code>org.simantics.sdk.build.targetdefinition.tpd</code></li>
+<li><code>simantics.tpd</code></li>
 </ul>
-<p>At the beginning of each .target file, increment <code>sequenceNumber</code> by 1</p>
-<pre><code>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;no&quot;?&gt;
-&lt;?pde version=&quot;3.8&quot;?&gt;
-&lt;target name=&quot;Simantics x.y.z[.w]&quot; sequenceNumber=&quot;11&quot;&gt;
-</code></pre>
-<p>Next, replace the following rows in those files:</p>
-<pre><code>&lt;repository location=&quot;http://www.simantics.org/download/master/sdk&quot;/&gt;
-&lt;repository location=&quot;http://www.simantics.org/download/master/external-components/maven&quot;/&gt;
-&lt;repository location=&quot;http://www.simantics.org/download/master/external-components/manual&quot;/&gt;
+<p>Replace the following rows in both mentioned files:</p>
+<pre><code>location &quot;http://www.simantics.org/download/master/external-components/maven&quot; {
+location &quot;http://www.simantics.org/download/master/external-components/manual&quot; {
+include &quot;http://www.simantics.org/download/master/org.simantics.sdk.build.targetdefinition.tpd&quot;
+location &quot;http://www.simantics.org/download/master/sdk&quot; {
 </code></pre>
 <p>with</p>
-<pre><code>&lt;repository location=&quot;http://www.simantics.org/download/release/x.y.z[.w]/sdk&quot;/&gt;
-&lt;repository location=&quot;http://www.simantics.org/download/release/x.y.z[.w]/external-components/maven&quot;/&gt;
-&lt;repository location=&quot;http://www.simantics.org/download/release/x.y.z[.w]/external-components/manual&quot;/&gt;
+<pre><code>location &quot;http://www.simantics.org/download/master/release/x.y.z[.w]/maven&quot; {
+location &quot;http://www.simantics.org/download/master/release/x.y.z[.w]/manual&quot; {
+include &quot;http://www.simantics.org/download/release/x.y.z[.w]/org.simantics.sdk.build.targetdefinition.tpd&quot;
+location &quot;http://www.simantics.org/download/release/x.y.z[.w]/sdk&quot; {
+</code></pre>
+</li>
+<li>
+<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>
+<pre><code>&lt;feature
+      id=&quot;org.simantics.sdk&quot;
+      label=&quot;Simantics SDK&quot;
+      version=&quot;x.y.z&quot;
+      provider-name=&quot;VTT Technical Research Centre of Finland&quot;&gt;
+</code></pre>
+<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>
+</li>
+<li>
+<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>
+</li>
+<li>
+<p>Commit the changes made</p>
+<pre><code> git commit -a
+</code></pre>
+<p>with the commit message</p>
+<pre><code> Configured release/x.y.z[.w] branch for SDK builds.
+
+ refs #xxxx
+</code></pre>
+<p>where <code>#xxxx</code> is the number of the x.y.z[.w] release engineering issue and push them to remote</p>
+<pre><code> git push origin release/x.y.z[.w]
 </code></pre>
 </li>
+<li>
+<p>If you are branching from <code>master</code>, bump the revision of master right now to start the next release cycle in master.
+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>
+<p>Commit the changes with the following commit message</p>
+<pre><code>Bumped master target and org.simantics.sdk feature versions to x.y.z[.w].
+
+refs #yyyy
+</code></pre>
+<p>where <code>#yyyy</code> is the number of the next release's release engineering issue.</p>
+</li>
 </ol>
 <h3>Initialize release branch distribution web site</h3>
 <ul>
@@ -397,12 +451,29 @@ git checkout release/x.y.z[.w]
 </ul>
 </li>
 </ul>
+<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>
+<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>
+<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>
+<h3>Update <code>.target</code> files</h3>
+<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>
+<p>Push the changed files to remote again with commit message:</p>
+<pre><code>Configured release/x.y.z[.w] branch .target files.
+
+refs #xxxx
+</code></pre>
+<h3>Test Release Train build</h3>
+<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>
+<ul>
+<li>GERRIT_REFNAME: <code>release/x.y.z[.w]</code></li>
+<li>PUBLISH_ARTIFACTS: <code>true</code></li>
+</ul>
+<p>to ensure that all components of the release train build fine and to publish first versions of P2 repositories of everything online.</p>
 <h2>Review documentation</h2>
 <p>Documentation to review:</p>
 <ul>
 <li><a href="http://dev.simantics.org/">Developer wiki</a></li>
-<li><a href="http://www.simantics.org/end_user_wiki">End-user wiki</a></li>
-<li><a href="http://www.simantics.org/members">Member wiki</a></li>
+<li><a href="https://www.simantics.org/end_user_wiki">End-user wiki</a></li>
+<li><a href="https://www.simantics.org/members">Member wiki</a></li>
 </ul>
 <p>For each wiki page:</p>
 <ul>
@@ -426,29 +497,36 @@ git checkout release/x.y.z[.w]
 <h2>Tag release/* branches</h2>
 <p>When the release branches are ready for the release, tag them with the tag <code>vx.y.z[.w]</code>:</p>
 <pre><code>git clone ssh://&lt;user&gt;@www.simantics.org:29418/simantics/platform.git
-cd platform    
+cd platform
 git checkout release/x.y.z[.w]
-git tag vx.y.z[.w] -m &quot;Simantics x.y.z[.w] release&quot;
+git tag vx.y.z[.w] -m &quot;Simantics x.y.z[.w] simultaneous release&quot;
 git push origin --tags
 
 git clone ssh://&lt;user&gt;@www.simantics.org:29418/simantics/third-party.git
 cd third-party
 git checkout release/x.y.z[.w]
-git tag vx.y.z[.w] -m &quot;Simantics x.y.z[.w] release&quot;
+git tag vx.y.z[.w] -m &quot;Simantics x.y.z[.w] simultaneous release&quot;
 git push origin --tags
 </code></pre>
 <blockquote>
 <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>.
 Only annotated or signed tags can be pushed to Gerrit.</p>
 </blockquote>
-<h2>Tag documentation wikis</h2>
-<p>Tag documentation wiki using <a href="./tag.sh">tag.sh</a> script.</p>
-<p>The wiki documentation is mainly in MediaWiki installations. The only sane way to tag the documentation is to clone it:</p>
+<h2>Backup documentation wiki databases</h2>
+<p>This step is only necessary for major/minor releases, not for service releases.</p>
+<p>The wiki databases to be backed up are:</p>
 <ul>
-<li>Copy the wiki installation from wiki to ${release_version}/wiki</li>
-<li>Copy the trunk wiki MySQL database into a new version</li>
-<li>Reconfigure the tagged wiki (LocalSettings.php) to use the copied database and no longer allow any edits</li>
+<li><a href="http://dev.simantics.org/">Developer wiki</a></li>
+<li><a href="https://www.simantics.org/end_user_wiki">End-user wiki</a></li>
 </ul>
+<p>These are MediaWiki installations. The only sane way to &quot;tag&quot; the documentation
+is to back up the mysql database backing the wiki. Should the wiki be required
+at a later time for some reason, we'll put the documentation up then in a
+separate Mediawiki installation.</p>
+<ol>
+<li>Dump documentation wiki databases using <a href="./dump-wikis.sh">dump-wikis.sh</a> script.</li>
+<li>Put the generated backup x.y.z.tar.gz at /var/backup/simantics-releases/x.y.z/wiki/</li>
+</ol>
 <h2>Compile change log entry</h2>
 <ul>
 <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>
@@ -497,14 +575,15 @@ Only annotated or signed tags can be pushed to Gerrit.</p>
 </ul>
 <h2>Disseminate information about the release</h2>
 <ul>
-<li><a href="https://www.simantics.org/redmine/">Redmine</a>: Post news on the developer/user-visible changes here.</li>
+<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>
+<li><a href="https://www.simantics.org/redmine/">Redmine</a>: Post news on the developer/user-visible changes here</li>
 <li><a href="https://www.simantics.org">simantics.org</a>: Post news on the release and a link to the redmine post</li>
-<li><a href="http://dev.simantics.org">dev wiki</a>: Update roadmap at http://dev.simantics.org/index.php/Roadmap</li>
-<li><a href="mailto:simantics-developers@simantics.org">simantics-developers@simantics.org</a> Send mail to simantics-developers:</li>
+<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>
+<li><a href="mailto:simantics-developers@simantics.org">mailto:simantics-developers@simantics.org</a> Send &quot;newsletter&quot; to `simantics-developers@simantics.org:</li>
 </ul>
-<p><strong>Mail template:</strong></p>
+<p><strong>Newsletter template:</strong></p>
 <pre><code>Hello everyone,
-   
+
 Simantics release x.y.z[.w] has been released. Head over to
 https://www.simantics.org/redmine/news/&lt;news number&gt;
 for the release news.
@@ -512,9 +591,11 @@ for the release news.
 Best regards,
 Simantics Release Engineering Team
 </code></pre>
-<p><strong>News entry template:</strong></p>
-<pre><code>On &lt;date&gt; Simantics x.y.z[.w] was tagged in SVN. Please find change log at:
-* [[simantics-platform:Simantics_xyzw|Simantics x.y.z.w]]
+<p><strong>Redmine news template:</strong></p>
+<pre><code>Title: Simantics x.y.z[.w] released
+
+Simantics x.y.z[.w] was released on &lt;date&gt;.
+Please find change log at: [[simantics-platform:Simantics_xyzw|Simantics x.y.z[.w]]]
 
 Insert some general thoughts on the release...
 </code></pre>
@@ -522,8 +603,6 @@ Insert some general thoughts on the release...
 <h1>TODO</h1>
 <ul>
 <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>
-<li>Create a parametrized release train pipeline build in Jenkins that creates all artifacts of a simantics release in one go</li>
-<li>Start using https://github.com/mbarbero/fr.obeo.releng.targetplatform to generate <code>.target</code> files. <code>.tpd</code> files allow specifying version ranges instead of specific versions.</li>
 </ul>
 
 </body>
