</ul>\r
<hr />\r
<h1>Released Plug-in Components and Products</h1>\r
-<p>There are both plug-in components and products that are part of the "Simantics release train" that shall be released simultaneously to a major or minor Simantics release.</p>\r
+<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
<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
-<p>Products that are part of the release train:</p>\r
-<ul>\r
-<li>Simantics Desktop</li>\r
-<li>Simantics System Dynamics Tool - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/sysdyn.git;a=summary">simantics/sysdyn.git</a></li>\r
-</ul>\r
<p>Plug-in components that are part of the release train:</p>\r
<ul>\r
-<li>Simantics R - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/r.git;a=summary">simantics/r.git</a></li>\r
+<li>Simupedia - <a href="https://www.simantics.org:8088/r/gitweb?p=members/simupedia.git;a=summary">members/simupedia.git</a></li>\r
<li>FMIL - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/fmil.git;a=summary">simantics/fmil.git</a></li>\r
<li>FMI Studio - <a href="https://www.simantics.org:8088/r/gitweb?p=members/fmi.git;a=summary">members/fmi.git</a></li>\r
-<li>Simupedia - <a href="https://www.simantics.org/svn/members/simupedia">Members SVN</a></li>\r
+<li>Interoperability components - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/interop.git;a=summary">simantics/interop.git</a></li>\r
+<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
+<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
+<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
+<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
+<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
+</ul>\r
+<p>Products that are part of the release train:</p>\r
+<ul>\r
+<li>Simantics Desktop</li>\r
+<li>Simantics System Dynamics Tool\r
+<ul>\r
+<li>This is Simantics Desktop with Simantics System Dynamics Tool features installed</li>\r
+</ul>\r
+</li>\r
</ul>\r
<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
<hr />\r
<p>When creating major/minor releases <code><commit></code> is usually a commit in the <code>master</code> branch.\r
With service releases, branch from an existing <code>release/*</code> branch instead.</p>\r
<h2>Prepare release branch for use</h2>\r
-<h3>Prepare .target files</h3>\r
+<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
+<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
+<h3>Prepare <code>.tpd</code> files</h3>\r
<ol>\r
<li>\r
<p>Retrieve release branch of the platform repository</p>\r
</code></pre>\r
</li>\r
<li>\r
-<p>Edit all target platform files in <code>releng/org.simantics.sdk.build.targetdefinition/</code>, i.e.</p>\r
+<p>Edit all target platform files in <code>releng/org.simantics.sdk.build.targetdefinition/</code>, i.e.</p>\r
<ul>\r
-<li><code>simantics.target</code></li>\r
-<li><code>org.simantics.sdk.build.targetdefinition.target</code></li>\r
+<li><code>org.simantics.sdk.build.targetdefinition.tpd</code></li>\r
+<li><code>simantics.tpd</code></li>\r
</ul>\r
-<p>At the beginning of simantics.target file, increment <code>sequenceNumber</code> by 1</p>\r
-<pre><code><?xml version="1.0" encoding="UTF-8" standalone="no"?>\r
-<?pde version="3.8"?>\r
-<target name="Simantics x.y.z[.w]" sequenceNumber="11">\r
-</code></pre>\r
-<p>Next, replace the following rows in both mentioned files:</p>\r
-<pre><code><repository location="http://www.simantics.org/download/master/sdk"/>\r
-<repository location="http://www.simantics.org/download/master/external-components/maven"/>\r
-<repository location="http://www.simantics.org/download/master/external-components/manual"/>\r
+<p>Replace the following rows in both mentioned files:</p>\r
+<pre><code>location "http://www.simantics.org/download/master/external-components/maven" {\r
+location "http://www.simantics.org/download/master/external-components/manual" {\r
+include "http://www.simantics.org/download/master/org.simantics.sdk.build.targetdefinition.tpd"\r
+location "http://www.simantics.org/download/master/sdk" {\r
</code></pre>\r
<p>with</p>\r
-<pre><code><repository location="http://www.simantics.org/download/release/x.y.z[.w]/sdk"/>\r
-<repository location="http://www.simantics.org/download/release/x.y.z[.w]/external-components/maven"/>\r
-<repository location="http://www.simantics.org/download/release/x.y.z[.w]/external-components/manual"/>\r
+<pre><code>location "http://www.simantics.org/download/master/release/x.y.z[.w]/maven" {\r
+location "http://www.simantics.org/download/master/release/x.y.z[.w]/manual" {\r
+include "http://www.simantics.org/download/release/x.y.z[.w]/org.simantics.sdk.build.targetdefinition.tpd"\r
+location "http://www.simantics.org/download/release/x.y.z[.w]/sdk" {\r
+</code></pre>\r
+</li>\r
+<li>\r
+<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
+<pre><code><feature\r
+ id="org.simantics.sdk"\r
+ label="Simantics SDK"\r
+ version="x.y.z"\r
+ provider-name="VTT Technical Research Centre of Finland">\r
+</code></pre>\r
+<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
+</li>\r
+<li>\r
+<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
+</li>\r
+<li>\r
+<p>Commit the changes made</p>\r
+<pre><code> git commit -a\r
+</code></pre>\r
+<p>with the commit message</p>\r
+<pre><code> Configured release/x.y.z[.w] branch for SDK builds.\r
+\r
+ refs #xxxx\r
</code></pre>\r
+<p>where <code>#xxxx</code> is the number of the x.y.z[.w] release engineering issue and push them to remote</p>\r
+<pre><code> git push origin release/x.y.z[.w]\r
+</code></pre>\r
+</li>\r
+<li>\r
+<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
+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
+<p>Commit the changes with the following commit message</p>\r
+<pre><code>Bumped master target and org.simantics.sdk feature versions to x.y.z[.w].\r
+\r
+refs #yyyy\r
+</code></pre>\r
+<p>where <code>#yyyy</code> is the number of the next release's release engineering issue.</p>\r
</li>\r
</ol>\r
<h3>Initialize release branch distribution web site</h3>\r
<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
<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
<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
+<h3>Update <code>.target</code> files</h3>\r
+<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
+<p>Push the changed files to remote again with commit message:</p>\r
+<pre><code>Configured release/x.y.z[.w] branch .target files.\r
+\r
+refs #xxxx\r
+</code></pre>\r
+<h3>Test Release Train build</h3>\r
+<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
+<ul>\r
+<li>GERRIT_REFNAME: <code>release/x.y.z[.w]</code></li>\r
+<li>PUBLISH_ARTIFACTS: <code>true</code></li>\r
+</ul>\r
+<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
<h2>Review documentation</h2>\r
<p>Documentation to review:</p>\r
<ul>\r
<h2>Tag release/* branches</h2>\r
<p>When the release branches are ready for the release, tag them with the tag <code>vx.y.z[.w]</code>:</p>\r
<pre><code>git clone ssh://<user>@www.simantics.org:29418/simantics/platform.git\r
-cd platform \r
+cd platform\r
git checkout release/x.y.z[.w]\r
-git tag vx.y.z[.w] -m "Simantics x.y.z[.w] release"\r
+git tag vx.y.z[.w] -m "Simantics x.y.z[.w] simultaneous release"\r
git push origin --tags\r
\r
git clone ssh://<user>@www.simantics.org:29418/simantics/third-party.git\r
cd third-party\r
git checkout release/x.y.z[.w]\r
-git tag vx.y.z[.w] -m "Simantics x.y.z[.w] release"\r
+git tag vx.y.z[.w] -m "Simantics x.y.z[.w] simultaneous release"\r
git push origin --tags\r
</code></pre>\r
<blockquote>\r
is to back up the mysql database backing the wiki. Should the wiki be required\r
at a later time for some reason, we'll put the documentation up then in a\r
separate Mediawiki installation.</p>\r
-<p>Dump documentation wiki databases using <a href="./dump-wikis.sh">dump-wikis.sh</a> script.</p>\r
+<ol>\r
+<li>Dump documentation wiki databases using <a href="./dump-wikis.sh">dump-wikis.sh</a> script.</li>\r
+<li>Put the generated backup x.y.z.tar.gz at /var/backup/simantics-releases/x.y.z/wiki/</li>\r
+</ol>\r
<h2>Compile change log entry</h2>\r
<ul>\r
<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
</ul>\r
<h2>Disseminate information about the release</h2>\r
<ul>\r
-<li><a href="http://dev.simantics.org">Developer Wiki</a>: Update roadmap at http://dev.simantics.org/index.php/Roadmap</li>\r
-<li><a href="https://www.simantics.org/redmine/">Redmine</a>: Post news on the developer/user-visible changes here.</li>\r
+<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
+<li><a href="https://www.simantics.org/redmine/">Redmine</a>: Post news on the developer/user-visible changes here</li>\r
<li><a href="https://www.simantics.org">simantics.org</a>: Post news on the release and a link to the redmine post</li>\r
<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
<li><a href="mailto:simantics-developers@simantics.org">mailto:simantics-developers@simantics.org</a> Send "newsletter" to `simantics-developers@simantics.org:</li>\r
</ul>\r
<p><strong>Newsletter template:</strong></p>\r
<pre><code>Hello everyone,\r
- \r
+\r
Simantics release x.y.z[.w] has been released. Head over to\r
https://www.simantics.org/redmine/news/<news number>\r
for the release news.\r
<hr />\r
<h1>TODO</h1>\r
<ul>\r
-<li>Create a parametrized release train pipeline build in Jenkins that creates all artifacts of a simantics release\r
-<ul>\r
-<li>Desktop, Sysdyn, R, Simupedia, FMIL, FMI Studio</li>\r
-</ul>\r
-</li>\r
-</ul>\r
-<ul>\r
-<li>\r
-<p>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</p>\r
-</li>\r
-<li>\r
-<p>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.</p>\r
-</li>\r
+<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
</ul>\r
\r
</body>\r
Code Review / simantics / platform.git / blobdiff