Modernized release engineering instructions.

diff --git a/releng/doc/release-helper.sh b/releng/doc/release-helper.sh
index 3f990dcf936b5e94326dde22e4f9d1c03860f57c..856182f223704973957a4e7ef887e6e7b8e072cc 100755 (executable)
--- a/releng/doc/release-helper.sh
+++ b/releng/doc/release-helper.sh
@@ -22,7 +22,7 @@ declare -a repositories=(
    "simantics/3d.git" "3d"
    "members/fmi.git" "fmi"
    "members/simupedia.git" "simupedia"
    "simantics/3d.git" "3d"
    "members/fmi.git" "fmi"
    "members/simupedia.git" "simupedia"

-   "gold-members/proteus.git" "simupedia"
+   "gold-members/proteus.git" "proteus"

 )
 
 repositoryCount=$((${#repositories[@]} / 2))
 )
 
 repositoryCount=$((${#repositories[@]} / 2))


@@ -114,6 +114,11 @@ case "$action" in
        ;;
 esac
 
        ;;
 esac
 

+if [ ! -d $version ]; then
+       echo "Version directory '$version' does not exist yet. Please run the 'clone' action first."
+       exit -1
+fi
+

 pushd $version > /dev/null
 case "$action" in
        branch)
 pushd $version > /dev/null
 case "$action" in
        branch)

diff --git a/releng/doc/release.html b/releng/doc/release.html
index ccb50611d4d4e536617091735e75fda901f1813b..222857de043939870404d944ae84ccbfde0c5eb4 100644 (file)
--- a/releng/doc/release.html
+++ b/releng/doc/release.html
@@ -324,22 +324,22 @@ img {
 <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>Core components of the release train:</p>\r
 <ul>\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>Core components of the release train:</p>\r
 <ul>\r

-<li>External third party library dependencies required by the platform - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/third-party.git;a=summary">simantics/third-party.git</a></li>\r
-<li>The Simantics Platform - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/platform.git;a=summary">simantics/platform.git</a></li>\r
+<li>External third party library dependencies required by the platform - <a href="https://gerrit.simantics.org/r/gitweb?p=simantics/third-party.git;a=summary">simantics/third-party.git</a></li>\r
+<li>The Simantics Platform - <a href="https://gerrit.simantics.org/r/gitweb?p=simantics/platform.git;a=summary">simantics/platform.git</a></li>\r

 </ul>\r
 <p>Plug-in components that are part of the release train:</p>\r
 <ul>\r
 </ul>\r
 <p>Plug-in components that are part of the release train:</p>\r
 <ul>\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>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
-<li>Simantics 3D modelling components - <a href="https://www.simantics.org:8088/r/gitweb?p=simantics/3d.git;a=summary">simantics/3d.git</a></li>\r
-<li>Simantics Proteus toolset - <a href="https://www.simantics.org:8088/r/gitweb?p=gold-members/proteus.git;a=summary">gold-members/proteus.git</a></li>\r
+<li>Simupedia - <a href="https://gerrit.simantics.org/r/gitweb?p=members/simupedia.git;a=summary">members/simupedia.git</a></li>\r
+<li>FMIL - <a href="https://gerrit.simantics.org/r/gitweb?p=simantics/fmil.git;a=summary">simantics/fmil.git</a></li>\r
+<li>FMI Studio - <a href="https://gerrit.simantics.org/r/gitweb?p=members/fmi.git;a=summary">members/fmi.git</a></li>\r
+<li>Interoperability components - <a href="https://gerrit.simantics.org/r/gitweb?p=simantics/interop.git;a=summary">simantics/interop.git</a></li>\r
+<li>Simantics R binding - <a href="https://gerrit.simantics.org/r/gitweb?p=simantics/r.git;a=summary">simantics/r.git</a></li>\r
+<li>Matlab SCL binding - <a href="https://gerrit.simantics.org/r/gitweb?p=simantics/matlab.git;a=summary">simantics/matlab.git</a></li>\r
+<li>Python SCL binding - <a href="https://gerrit.simantics.org/r/gitweb?p=simantics/python.git;a=summary">simantics/python.git</a></li>\r
+<li>Simantics System Dynamics - <a href="https://gerrit.simantics.org/r/gitweb?p=simantics/sysdyn.git;a=summary">simantics/sysdyn.git</a></li>\r
+<li>Simantics District modelling components - <a href="https://gerrit.simantics.org/r/gitweb?p=simantics/district.git;a=summary">simantics/district.git</a></li>\r
+<li>Simantics 3D modelling components - <a href="https://gerrit.simantics.org/r/gitweb?p=simantics/3d.git;a=summary">simantics/3d.git</a></li>\r
+<li>Simantics Proteus toolset - <a href="https://gerrit.simantics.org/r/gitweb?p=gold-members/proteus.git;a=summary">gold-members/proteus.git</a></li>\r

 </ul>\r
 <p>Products that are part of the release train:</p>\r
 <ul>\r
 </ul>\r
 <p>Products that are part of the release train:</p>\r
 <ul>\r


@@ -362,36 +362,47 @@ img {
 <h1>Simantics Platform Release - Step by Step</h1>\r
 <h2>Create release branch from selected commit</h2>\r
 <p>When release stabilisation starts, branch all relevant repositories like this:</p>\r
 <h1>Simantics Platform Release - Step by Step</h1>\r
 <h2>Create release branch from selected commit</h2>\r
 <p>When release stabilisation starts, branch all relevant repositories like this:</p>\r

-<pre><code>git clone ssh://&lt;user&gt;@www.simantics.org:29418/simantics/platform.git\r
+<pre><code>git clone ssh://&lt;user&gt;@gerrit.simantics.org:29418/simantics/platform.git\r

 cd platform\r
 git branch release/x.y.z[.w] &lt;commit&gt;\r
 git push origin release/x.y.z[.w]\r
 </code></pre>\r
 <p>When creating major/minor releases <code>&lt;commit&gt;</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
 cd platform\r
 git branch release/x.y.z[.w] &lt;commit&gt;\r
 git push origin release/x.y.z[.w]\r
 </code></pre>\r
 <p>When creating major/minor releases <code>&lt;commit&gt;</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

-<p>Use of the included <code>release-helper.sh</code> shell script is highly encouraged to perform this mechanical work. The script supports many useful basic git commands which all perform the requested operation on all the release train repositories. The operations can be seen from the help text printed by the script when given no arguments:</p>\r
+<p>Instead of doing this clone+branch+push sequence for every SDK repository separately,\r
+please use the included <code>release-helper.sh</code> shell script to perform this mechanical work. The script supports many useful basic git commands which all perform the requested operation on all the release train repositories. The operations can be seen from the help text printed by the script when given no arguments:</p>\r

 <pre><code>Usage: release-helper.sh &lt;version&gt; &lt;branch-name&gt; &lt;user-name&gt; clone|branch|checkout|fetch|list-tags|pull|push|push-tags|remove-tag|status|tag\r
 </code></pre>\r
 <pre><code>Usage: release-helper.sh &lt;version&gt; &lt;branch-name&gt; &lt;user-name&gt; clone|branch|checkout|fetch|list-tags|pull|push|push-tags|remove-tag|status|tag\r
 </code></pre>\r

-<p>First, begin by cloning all the repositories:</p>\r
+<p>Always begin by cloning all the repositories for working on</p>\r

 <pre><code>./release-helper.sh x.y.z release/x.y.z your-git-username clone\r
 </code></pre>\r
 <pre><code>./release-helper.sh x.y.z release/x.y.z your-git-username clone\r
 </code></pre>\r

-<p>This will create a directory called <code>x.y.z</code> under the current working directory and clone all the repositories under it.</p>\r
+<p>This will create a directory called <code>x.y.z</code> under the current working directory and clone all the repositories under it. The first <code>&lt;version&gt;</code> argument is only used for the base working directory <code>x.y.z</code>. The second <code>&lt;branch-name&gt;</code> argument tells what branch to specify to the action, i.e. <code>branch</code>, <code>checkout</code>, etc.</p>\r

 <p>Branching and pushing the branches to remote happens as follows:</p>\r
 <pre><code>./release-helper.sh x.y.z release/x.y.z your-git-username branch\r
 <p>Branching and pushing the branches to remote happens as follows:</p>\r
 <pre><code>./release-helper.sh x.y.z release/x.y.z your-git-username branch\r

+./release-helper.sh x.y.z release/x.y.z your-git-username checkout\r

 ./release-helper.sh x.y.z release/x.y.z your-git-username push\r
 </code></pre>\r
 ./release-helper.sh x.y.z release/x.y.z your-git-username push\r
 </code></pre>\r

+<p>If you're creating a service release <code>x.y.w</code> from <code>x.y.z</code> where <code>w &gt; z</code>, do this:</p>\r
+<pre><code>./release-helper.sh x.y.w release/x.y.z your-git-username clone\r
+./release-helper.sh x.y.w release/x.y.z your-git-username checkout\r
+./release-helper.sh x.y.w release/x.y.w your-git-username branch\r
+./release-helper.sh x.y.w release/x.y.w your-git-username checkout\r
+# Perhaps make modifications to the branch here and commit to each project separately\r
+./release-helper.sh x.y.w release/x.y.w your-git-username push\r
+</code></pre>\r

 <h2>Prepare release branch for use</h2>\r
 <h2>Prepare release branch for use</h2>\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 release 1.31.0 Simantics started using 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
 <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
+<h3>Prepare <code>.tpd</code> files in platform repository</h3>\r
+<ol start="0">\r

 <li>\r
 <li>\r

-<p>Retrieve release branch of the platform repository</p>\r
-<pre><code>git clone ssh://&lt;user&gt;@www.simantics.org:29418/simantics/platform.git\r
-cd platform\r
-git branch release/x.y.z[.w] remotes/origin/release/x.y.z[.w]\r
-git checkout release/x.y.z[.w]\r
+<p>Ensure you've ran</p>\r
+<pre><code>./release-helper.sh x.y.z release/x.y.z your-git-username checkout\r

 </code></pre>\r
 </code></pre>\r

+<p>to make sure you're working on the release branch before doing anything.</p>\r
+</li>\r
+<li>\r
+<p>Go into the cloned platform repository at <code>x.y.z/platform</code></p>\r

 </li>\r
 <li>\r
 <p>Edit all target platform files in <code>releng/org.simantics.sdk.build.targetdefinition/</code>, i.e.</p>\r
 </li>\r
 <li>\r
 <p>Edit all target platform files in <code>releng/org.simantics.sdk.build.targetdefinition/</code>, i.e.</p>\r


@@ -413,18 +424,30 @@ location &quot;http://www.simantics.org/download/release/x.y.z[.w]/sdk&quot; {
 </code></pre>\r
 </li>\r
 <li>\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
+<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</code>.</p>\r

 <pre><code>&lt;feature\r
       id=&quot;org.simantics.sdk&quot;\r
       label=&quot;Simantics SDK&quot;\r
       version=&quot;x.y.z&quot;\r
       provider-name=&quot;VTT Technical Research Centre of Finland&quot;&gt;\r
 </code></pre>\r
 <pre><code>&lt;feature\r
       id=&quot;org.simantics.sdk&quot;\r
       label=&quot;Simantics SDK&quot;\r
       version=&quot;x.y.z&quot;\r
       provider-name=&quot;VTT Technical Research Centre of Finland&quot;&gt;\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%2Fplatform.git;a=commit;h=5271b0faa98303225d00e6cd838d3fc52488545c">gitweb</a> or <a href="https://www.simantics.org:8088/r/#/c/1361/">review 1361</a>.</p>\r
+<p>If the release branch you're setting up is a hotfix-release <code>x.y.z.w</code>,\r
+don't include the <code>.w</code> part in this version.</p>\r
+<p>An example of these changes can be seen in\r
+<a href="https://gerrit.simantics.org/r/gitweb?p=simantics%2Fplatform.git;a=commit;h=5271b0faa98303225d00e6cd838d3fc52488545c">gitweb</a>\r
+or <a href="https://gerrit.simantics.org/r/#/c/1361/">review 1361</a>.</p>\r

 </li>\r
 <li>\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
+<p>Ensure that Gitlab has a release engineering issue for the branched release,\r
+such as <a href="https://gitlab.simantics.org/simantics/platform/issues/16">Simantics 1.34.0 release engineering</a></p>\r
+<ul>\r
+<li>Make a new release issue with title <code>$version release engineering</code>.</li>\r
+<li>Add a link to the previous previous release's issue in the new issue description, e.g. <code>simantics/platform#16</code>.</li>\r
+<li>Add labels <code>releng</code> and <code>$version</code> to the new issue</li>\r
+</ul>\r

 </li>\r
 </li>\r

+</ol>\r
+<ol start="5">\r

 <li>\r
 <p>Commit the changes made</p>\r
 <pre><code> git commit -a\r
 <li>\r
 <p>Commit the changes made</p>\r
 <pre><code> git commit -a\r


@@ -432,7 +455,7 @@ location &quot;http://www.simantics.org/download/release/x.y.z[.w]/sdk&quot; {
 <p>with the commit message</p>\r
 <pre><code> Configured release/x.y.z[.w] branch for SDK builds.\r
 \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
+ gitlab #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
 <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


@@ -440,7 +463,7 @@ location &quot;http://www.simantics.org/download/release/x.y.z[.w]/sdk&quot; {
 </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
 </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%2Fplatform.git;a=commit;h=564ac84a2949b19ce5c1c7c838b575527ec42b09">gitweb</a> or in <a href="https://www.simantics.org:8088/r/#/c/1362">review 1362</a>. The changes include:</p>\r
+An example of these changes can be seen in <a href="https://gerrit.simantics.org/r/gitweb?p=simantics%2Fplatform.git;a=commit;h=564ac84a2949b19ce5c1c7c838b575527ec42b09">gitweb</a> or in <a href="https://gerrit.simantics.org/r/#/c/1362">review 1362</a>. The changes include:</p>\r

 <ul>\r
 <li>Simantics Desktop splash screen update (version number)</li>\r
 <li>Simantics target platform name to state correct development version</li>\r
 <ul>\r
 <li>Simantics Desktop splash screen update (version number)</li>\r
 <li>Simantics target platform name to state correct development version</li>\r


@@ -450,37 +473,15 @@ An example of these changes can be seen in <a href="https://www.simantics.org:80
 <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
 <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
+gitlab #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
 </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
-<ul>\r
-<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
-<ul>\r
-<li><strong>GERRIT_REFNAME:</strong> <code>release/x.y.z[.w]</code></li>\r
-<li><strong>PUBLISH_ARTIFACTS:</strong> <code>true</code></li>\r
-</ul>\r
-</li>\r
-<li>Run the <a href="https://www.simantics.org/jenkins/job/SDK/job/Simantics%20SDK/">SDK/Simantics SDK</a> build with parameters:\r
-<ul>\r
-<li><strong>GERRIT_REFNAME:</strong> <code>release/x.y.z[.w]</code></li>\r
-<li><strong>PUBLISH_ARTIFACTS:</strong> <code>true</code></li>\r
-</ul>\r
+<li>\r
+<p>Do the same for simupedia target platform files as was done in task 6.\r
+for platform target definitions.</p>\r

 </li>\r
 </li>\r

-</ul>\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 release-branch <code>.target</code> files</h3>\r
-<p>Next, we want to change the <code>.tpd</code> and <code>.target</code> files to point to the correct P2 repository locations in the release-branch. 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
-<p>See <a href="https://www.simantics.org:8088/r/#/c/1361">review 1361</a> for an example.</p>\r
+</ol>\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
 <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


@@ -488,6 +489,27 @@ refs #xxxx
 <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
 <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

+<p>The release train build is currently never ran automatically.\r
+However, after following all these steps, whenever changes are pushed/merged to <code>release/x.y.z[.w]</code> branch in Gerrit, new Jenkins builds are triggered automatically and they will publish the results (P2 repositories/products) at their designated locations online.</p>\r
+<h4>[Optional reading] Release train build details</h4>\r
+<p>The release train build does two very important steps as the first things,\r
+i.e. build the external dependency P2 repositories for both the\r
+Platform SDK and Simupedia:</p>\r
+<pre><code>stage('External Dependencies') {\r
+    node {\r
+        build job: 'SDK/Deploy External Components to Web', parameters: params1\r
+        build job: 'Member Components/Simupedia/fi.semantum.simupedia.build.p2.site', parameters: params1\r
+    }    \r
+}\r
+</code></pre>\r
+<p>After that it builds the Platform SDK and Simupedia before building anything else:</p>\r
+<pre><code>stage('SDK') {\r
+    node {\r
+        build job: 'SDK/Simantics SDK', parameters: params1\r
+        // Note that Simantics SDK builds simupedia-git as well\r
+    }\r
+}\r
+</code></pre>\r

 <h2>Review documentation</h2>\r
 <p>Documentation to review:</p>\r
 <ul>\r
 <h2>Review documentation</h2>\r
 <p>Documentation to review:</p>\r
 <ul>\r


@@ -516,20 +538,13 @@ refs #xxxx
 </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
 </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://&lt;user&gt;@www.simantics.org:29418/simantics/platform.git\r
-cd platform\r
-git checkout release/x.y.z[.w]\r
-git tag vx.y.z[.w] -m &quot;Simantics x.y.z[.w] simultaneous release&quot;\r
-git push origin --tags\r
-\r
-git clone ssh://&lt;user&gt;@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 &quot;Simantics x.y.z[.w] simultaneous release&quot;\r
-git push origin --tags\r
+<pre><code>./release-helper.sh x.y.z release/x.y.z your-git-username checkout\r
+./release-helper.sh x.y.z release/x.y.z your-git-username pull\r
+./release-helper.sh x.y.z release/x.y.z your-git-username tag\r
+./release-helper.sh x.y.z release/x.y.z your-git-username push-tags\r

 </code></pre>\r
 <blockquote>\r
 </code></pre>\r
 <blockquote>\r

-<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
+<p>Note: release-helper.sh will supply the -m argument to git tag to create an <a href="https://git-scm.com/book/en/v2/Git-Basics-Tagging">annotated tag</a>.\r

 Only annotated or signed tags can be pushed to Gerrit.</p>\r
 </blockquote>\r
 <h2>Backup documentation wiki databases</h2>\r
 Only annotated or signed tags can be pushed to Gerrit.</p>\r
 </blockquote>\r
 <h2>Backup documentation wiki databases</h2>\r

diff --git a/releng/doc/release.md b/releng/doc/release.md
index fffb2f8628bad5d29f88eb5e821a2eabf771637a..da394696c63940af28905684b045a2d00916d41d 100644 (file)
--- a/releng/doc/release.md
+++ b/releng/doc/release.md
@@ -29,21 +29,21 @@ There are both plug-in components and products that are part of the _Simantics R
 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.
 
 Core components of the release train:
 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.
 
 Core components of the release train:

-* External third party library dependencies required by the platform - [simantics/third-party.git](https://www.simantics.org:8088/r/gitweb?p=simantics/third-party.git;a=summary)\r
-* The Simantics Platform - [simantics/platform.git](https://www.simantics.org:8088/r/gitweb?p=simantics/platform.git;a=summary)\r
+* External third party library dependencies required by the platform - [simantics/third-party.git](https://gerrit.simantics.org/r/gitweb?p=simantics/third-party.git;a=summary)\r
+* The Simantics Platform - [simantics/platform.git](https://gerrit.simantics.org/r/gitweb?p=simantics/platform.git;a=summary)\r

 
 Plug-in components that are part of the release train:
 
 Plug-in components that are part of the release train:

-* Simupedia - [members/simupedia.git](https://www.simantics.org:8088/r/gitweb?p=members/simupedia.git;a=summary)
-* FMIL - [simantics/fmil.git](https://www.simantics.org:8088/r/gitweb?p=simantics/fmil.git;a=summary)
-* FMI Studio - [members/fmi.git](https://www.simantics.org:8088/r/gitweb?p=members/fmi.git;a=summary)
-* Interoperability components - [simantics/interop.git](https://www.simantics.org:8088/r/gitweb?p=simantics/interop.git;a=summary)
-* Simantics R binding - [simantics/r.git](https://www.simantics.org:8088/r/gitweb?p=simantics/r.git;a=summary)
-* Matlab SCL binding - [simantics/matlab.git](https://www.simantics.org:8088/r/gitweb?p=simantics/matlab.git;a=summary)
-* Python SCL binding - [simantics/python.git](https://www.simantics.org:8088/r/gitweb?p=simantics/python.git;a=summary)
-* Simantics System Dynamics - [simantics/sysdyn.git](https://www.simantics.org:8088/r/gitweb?p=simantics/sysdyn.git;a=summary)
-* Simantics District modelling components - [simantics/district.git](https://www.simantics.org:8088/r/gitweb?p=simantics/district.git;a=summary)
-* Simantics 3D modelling components - [simantics/3d.git](https://www.simantics.org:8088/r/gitweb?p=simantics/3d.git;a=summary)
-* Simantics Proteus toolset - [gold-members/proteus.git](https://www.simantics.org:8088/r/gitweb?p=gold-members/proteus.git;a=summary)
+* Simupedia - [members/simupedia.git](https://gerrit.simantics.org/r/gitweb?p=members/simupedia.git;a=summary)
+* FMIL - [simantics/fmil.git](https://gerrit.simantics.org/r/gitweb?p=simantics/fmil.git;a=summary)
+* FMI Studio - [members/fmi.git](https://gerrit.simantics.org/r/gitweb?p=members/fmi.git;a=summary)
+* Interoperability components - [simantics/interop.git](https://gerrit.simantics.org/r/gitweb?p=simantics/interop.git;a=summary)
+* Simantics R binding - [simantics/r.git](https://gerrit.simantics.org/r/gitweb?p=simantics/r.git;a=summary)
+* Matlab SCL binding - [simantics/matlab.git](https://gerrit.simantics.org/r/gitweb?p=simantics/matlab.git;a=summary)
+* Python SCL binding - [simantics/python.git](https://gerrit.simantics.org/r/gitweb?p=simantics/python.git;a=summary)
+* Simantics System Dynamics - [simantics/sysdyn.git](https://gerrit.simantics.org/r/gitweb?p=simantics/sysdyn.git;a=summary)
+* Simantics District modelling components - [simantics/district.git](https://gerrit.simantics.org/r/gitweb?p=simantics/district.git;a=summary)
+* Simantics 3D modelling components - [simantics/3d.git](https://gerrit.simantics.org/r/gitweb?p=simantics/3d.git;a=summary)
+* Simantics Proteus toolset - [gold-members/proteus.git](https://gerrit.simantics.org/r/gitweb?p=gold-members/proteus.git;a=summary)

 
 Products that are part of the release train:
 * Simantics Desktop
 
 Products that are part of the release train:
 * Simantics Desktop


@@ -68,7 +68,7 @@ For simplicity, each of these components are versioned accoring to platform vers
 
 When release stabilisation starts, branch all relevant repositories like this:
 
 
 When release stabilisation starts, branch all relevant repositories like this:
 

-    git clone ssh://<user>@www.simantics.org:29418/simantics/platform.git
+    git clone ssh://<user>@gerrit.simantics.org:29418/simantics/platform.git

     cd platform
     git branch release/x.y.z[.w] <commit>
     git push origin release/x.y.z[.w]
     cd platform
     git branch release/x.y.z[.w] <commit>
     git push origin release/x.y.z[.w]


@@ -76,35 +76,47 @@ When release stabilisation starts, branch all relevant repositories like this:
 When creating major/minor releases `<commit>` is usually a commit in the `master` branch.
 With service releases, branch from an existing `release/*` branch instead.
 
 When creating major/minor releases `<commit>` is usually a commit in the `master` branch.
 With service releases, branch from an existing `release/*` branch instead.
 

-Use of the included `release-helper.sh` shell script is highly encouraged to perform this mechanical work. The script supports many useful basic git commands which all perform the requested operation on all the release train repositories. The operations can be seen from the help text printed by the script when given no arguments:
+Instead of doing this clone+branch+push sequence for every SDK repository separately,
+please use the included `release-helper.sh` shell script to perform this mechanical work. The script supports many useful basic git commands which all perform the requested operation on all the release train repositories. The operations can be seen from the help text printed by the script when given no arguments:

 
     Usage: release-helper.sh <version> <branch-name> <user-name> clone|branch|checkout|fetch|list-tags|pull|push|push-tags|remove-tag|status|tag
 
 
     Usage: release-helper.sh <version> <branch-name> <user-name> clone|branch|checkout|fetch|list-tags|pull|push|push-tags|remove-tag|status|tag
 

-First, begin by cloning all the repositories:
+Always begin by cloning all the repositories for working on 

 
     ./release-helper.sh x.y.z release/x.y.z your-git-username clone
 
 
     ./release-helper.sh x.y.z release/x.y.z your-git-username clone
 

-This will create a directory called `x.y.z` under the current working directory and clone all the repositories under it.
+This will create a directory called `x.y.z` under the current working directory and clone all the repositories under it. The first `<version>` argument is only used for the base working directory `x.y.z`. The second `<branch-name>` argument tells what branch to specify to the action, i.e. `branch`, `checkout`, etc.

 
 Branching and pushing the branches to remote happens as follows:
 
     ./release-helper.sh x.y.z release/x.y.z your-git-username branch
 
 Branching and pushing the branches to remote happens as follows:
 
     ./release-helper.sh x.y.z release/x.y.z your-git-username branch

+    ./release-helper.sh x.y.z release/x.y.z your-git-username checkout

     ./release-helper.sh x.y.z release/x.y.z your-git-username push
 
     ./release-helper.sh x.y.z release/x.y.z your-git-username push
 

+If you're creating a service release `x.y.w` from `x.y.z` where `w > z`, do this:
+
+    ./release-helper.sh x.y.w release/x.y.z your-git-username clone
+    ./release-helper.sh x.y.w release/x.y.z your-git-username checkout
+    ./release-helper.sh x.y.w release/x.y.w your-git-username branch
+    ./release-helper.sh x.y.w release/x.y.w your-git-username checkout
+    # Perhaps make modifications to the branch here and commit to each project separately
+    ./release-helper.sh x.y.w release/x.y.w your-git-username push
+

 ## Prepare release branch for use
 
 ## Prepare release branch for use
 

-In release 1.31.0 Simantics started using uses the wonderful tool from Obeo ([https://github.com/mbarbero/fr.obeo.releng.targetplatform](https://github.com/mbarbero/fr.obeo.releng.targetplatform)) to generate `.target` files from `.tpd` files which allow much simpler specification of the target contents and also composition of .tpd files via inclusion.
+In release 1.31.0 Simantics started using the wonderful tool from Obeo ([https://github.com/mbarbero/fr.obeo.releng.targetplatform](https://github.com/mbarbero/fr.obeo.releng.targetplatform)) to generate `.target` files from `.tpd` files which allow much simpler specification of the target contents and also composition of .tpd files via inclusion.

 
 In the following steps, it is recommended to ensure every `.target` file is up-to-date by regenerating them from `.tpd` files. While doing so, take care to use up-to-date online contents to perform the generation.
 
 
 In the following steps, it is recommended to ensure every `.target` file is up-to-date by regenerating them from `.tpd` files. While doing so, take care to use up-to-date online contents to perform the generation.
 

-### Prepare `.tpd` files
+### Prepare `.tpd` files in platform repository
+
+0. Ensure you've ran\r
+ 
+       ./release-helper.sh x.y.z release/x.y.z your-git-username checkout

 
 

-1. Retrieve release branch of the platform repository
+   to make sure you're working on the release branch before doing anything.

 
 

-       git clone ssh://<user>@www.simantics.org:29418/simantics/platform.git
-       cd platform
-       git branch release/x.y.z[.w] remotes/origin/release/x.y.z[.w]
-       git checkout release/x.y.z[.w]
+1. Go into the cloned platform repository at `x.y.z/platform`\r

 
 2. Edit all target platform files in `releng/org.simantics.sdk.build.targetdefinition/`, i.e.
    * `org.simantics.sdk.build.targetdefinition.tpd`
 
 2. Edit all target platform files in `releng/org.simantics.sdk.build.targetdefinition/`, i.e.
    * `org.simantics.sdk.build.targetdefinition.tpd`


@@ -128,7 +140,7 @@ In the following steps, it is recommended to ensure every `.target` file is up-t
    location "http://www.simantics.org/download/release/x.y.z[.w]/sdk" {
    ~~~
 
    location "http://www.simantics.org/download/release/x.y.z[.w]/sdk" {
    ~~~
 

-3. Edit version number of `org.simantics.sdk` feature in `features/org.simantics.sdk.feature/feature.xml` to `x.y.z[.w]`.
+3. Edit version number of `org.simantics.sdk` feature in `features/org.simantics.sdk.feature/feature.xml` to `x.y.z`.

    ~~~
    <feature
          id="org.simantics.sdk"
    ~~~
    <feature
          id="org.simantics.sdk"


@@ -137,9 +149,19 @@ In the following steps, it is recommended to ensure every `.target` file is up-t
          provider-name="VTT Technical Research Centre of Finland">
    ~~~
 
          provider-name="VTT Technical Research Centre of Finland">
    ~~~
 

-   An example of these changes can be seen in [gitweb](https://www.simantics.org:8088/r/gitweb?p=simantics%2Fplatform.git;a=commit;h=5271b0faa98303225d00e6cd838d3fc52488545c) or [review 1361](https://www.simantics.org:8088/r/#/c/1361/).
+   If the release branch you're setting up is a hotfix-release `x.y.z.w`,
+   don't include the `.w` part in this version.
+
+   An example of these changes can be seen in
+   [gitweb](https://gerrit.simantics.org/r/gitweb?p=simantics%2Fplatform.git;a=commit;h=5271b0faa98303225d00e6cd838d3fc52488545c)
+   or [review 1361](https://gerrit.simantics.org/r/#/c/1361/).
+
+4. Ensure that Gitlab has a release engineering issue for the branched release,
+   such as [Simantics 1.34.0 release engineering](https://gitlab.simantics.org/simantics/platform/issues/16)   
+   * Make a new release issue with title `$version release engineering`.
+   * Add a link to the previous previous release's issue in the new issue description, e.g. `simantics/platform#16`.
+   * Add labels `releng` and `$version` to the new issue

 
 

-4. Ensure that Redmine has a release engineering issue for the branched release, such as [Simantics 1.30.0 release engineering](https://www.simantics.org/redmine/issues/7263). Make a copy of the previous release issue to create the new one. Include link to original issue while copying.

 
 5. Commit the changes made
 
 
 5. Commit the changes made
 


@@ -149,14 +171,14 @@ In the following steps, it is recommended to ensure every `.target` file is up-t
 
         Configured release/x.y.z[.w] branch for SDK builds.
 
 
         Configured release/x.y.z[.w] branch for SDK builds.
 

-        refs #xxxx
+        gitlab #xxxx

 
    where `#xxxx` is the number of the x.y.z[.w] release engineering issue and push them to remote
 
         git push origin release/x.y.z[.w]
 
 6. If you are branching from `master`, bump the revision of master right now to start the next release cycle in master.
 
    where `#xxxx` is the number of the x.y.z[.w] release engineering issue and push them to remote
 
         git push origin release/x.y.z[.w]
 
 6. If you are branching from `master`, bump the revision of master right now to start the next release cycle in master.

-   An example of these changes can be seen in [gitweb](https://www.simantics.org:8088/r/gitweb?p=simantics%2Fplatform.git;a=commit;h=564ac84a2949b19ce5c1c7c838b575527ec42b09) or in [review 1362](https://www.simantics.org:8088/r/#/c/1362). The changes include:
+   An example of these changes can be seen in [gitweb](https://gerrit.simantics.org/r/gitweb?p=simantics%2Fplatform.git;a=commit;h=564ac84a2949b19ce5c1c7c838b575527ec42b09) or in [review 1362](https://gerrit.simantics.org/r/#/c/1362). The changes include:

    * Simantics Desktop splash screen update (version number)
    * Simantics target platform name to state correct development version
    * org.simantics.sdk feature version bump
    * Simantics Desktop splash screen update (version number)
    * Simantics target platform name to state correct development version
    * org.simantics.sdk feature version bump


@@ -166,45 +188,47 @@ In the following steps, it is recommended to ensure every `.target` file is up-t
 
        Bumped master target and org.simantics.sdk feature versions to x.y.z[.w].
 
 
        Bumped master target and org.simantics.sdk feature versions to x.y.z[.w].
 

-       refs #yyyy
+       gitlab #yyyy

 
    where `#yyyy` is the number of the next release's release engineering issue.
 
 
    where `#yyyy` is the number of the next release's release engineering issue.
 

-### Initialize release branch distribution web site
-
-* Run [SDK/Deploy External Components to Web](https://www.simantics.org/jenkins/job/SDK/job/Deploy%20External%20Components%20to%20Web/) build with parameters:
-  * **GERRIT_REFNAME:** `release/x.y.z[.w]`
-  * **PUBLISH_ARTIFACTS:** `true`
-* Run the [SDK/Simantics SDK](https://www.simantics.org/jenkins/job/SDK/job/Simantics%20SDK/) build with parameters:
-  * **GERRIT_REFNAME:** `release/x.y.z[.w]`
-  * **PUBLISH_ARTIFACTS:** `true`
-
-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 `http://www.simantics.org/download/release/x.y.z[.w]/`.
-
-After this, whenever changes are pushed/merged to `release/x.y.z[.w]` branch in Gerrit, new **SDK/Simantics SDK** builds are triggered automatically and they will publish the results at the same location online.
-
-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 [SDK/Simantics SDK](https://www.simantics.org/jenkins/job/SDK/job/Simantics%20SDK/) Jenkins job.
-
-### Update release-branch `.target` files
-
-Next, we want to change the `.tpd` and `.target` files to point to the correct P2 repository locations in the release-branch. This happens by opening the previously edited `.tpd` files in Obeo's editor and regenerating the `.target` files by pressing Alt+R.
-
-Push the changed files to remote again with commit message:
-
-    Configured release/x.y.z[.w] branch .target files.
-
-    refs #xxxx
-
-See [review 1361](https://www.simantics.org:8088/r/#/c/1361) for an example.
+7. Do the same for simupedia target platform files as was done in task 6.\r
+   for platform target definitions.

 
 ### Test Release Train build
 
 Trigger an execution of the [simantics-release-train](https://www.simantics.org/jenkins/job/simantics-release-train/) Jenkins job with parameters
 
 ### Test Release Train build
 
 Trigger an execution of the [simantics-release-train](https://www.simantics.org/jenkins/job/simantics-release-train/) Jenkins job with parameters

-* GERRIT_REFNAME: `release/x.y.z[.w]`\r
-* PUBLISH_ARTIFACTS: `true`\r
+* GERRIT_REFNAME: `release/x.y.z[.w]`
+* PUBLISH_ARTIFACTS: `true`

 
 to ensure that all components of the release train build fine and to publish first versions of P2 repositories of everything online.
 
 
 to ensure that all components of the release train build fine and to publish first versions of P2 repositories of everything online.
 

+The release train build is currently never ran automatically. 
+However, after following all these steps, whenever changes are pushed/merged to `release/x.y.z[.w]` branch in Gerrit, new Jenkins builds are triggered automatically and they will publish the results (P2 repositories/products) at their designated locations online.
+
+#### [Optional reading] Release train build details
+
+The release train build does two very important steps as the first things,
+i.e. build the external dependency P2 repositories for both the
+Platform SDK and Simupedia:
+~~~
+stage('External Dependencies') {
+    node {
+        build job: 'SDK/Deploy External Components to Web', parameters: params1
+        build job: 'Member Components/Simupedia/fi.semantum.simupedia.build.p2.site', parameters: params1
+    }    
+}
+~~~
+After that it builds the Platform SDK and Simupedia before building anything else:
+~~~
+stage('SDK') {
+    node {
+        build job: 'SDK/Simantics SDK', parameters: params1
+        // Note that Simantics SDK builds simupedia-git as well
+    }
+}
+~~~
+

 ## Review documentation
 
 Documentation to review:
 ## Review documentation
 
 Documentation to review:


@@ -227,19 +251,12 @@ For each wiki page:
 
 When the release branches are ready for the release, tag them with the tag `vx.y.z[.w]`:
 
 
 When the release branches are ready for the release, tag them with the tag `vx.y.z[.w]`:
 

-    git clone ssh://<user>@www.simantics.org:29418/simantics/platform.git
-    cd platform
-    git checkout release/x.y.z[.w]
-    git tag vx.y.z[.w] -m "Simantics x.y.z[.w] simultaneous release"
-    git push origin --tags
-
-    git clone ssh://<user>@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 "Simantics x.y.z[.w] simultaneous release"
-    git push origin --tags
+    ./release-helper.sh x.y.z release/x.y.z your-git-username checkout
+    ./release-helper.sh x.y.z release/x.y.z your-git-username pull
+    ./release-helper.sh x.y.z release/x.y.z your-git-username tag
+    ./release-helper.sh x.y.z release/x.y.z your-git-username push-tags

 
 

-> Note The -m argument must be supplied to create an [annotated tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging).
+> Note: release-helper.sh will supply the -m argument to git tag to create an [annotated tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging).

 > Only annotated or signed tags can be pushed to Gerrit.
 
 ## Backup documentation wiki databases
 > Only annotated or signed tags can be pushed to Gerrit.
 
 ## Backup documentation wiki databases