Updated release engineering instructions 63/1363/1
authorTuukka Lehtonen <tuukka.lehtonen@semantum.fi>
Mon, 8 Jan 2018 13:57:25 +0000 (15:57 +0200)
committerTuukka Lehtonen <tuukka.lehtonen@semantum.fi>
Mon, 8 Jan 2018 13:57:25 +0000 (15:57 +0200)
refs #7712

Change-Id: I511149845a69a686832665bcc95ac854ee00bbe4

releng/doc/release.html
releng/doc/release.md

index cd2aea0df6965c97a955da02316cf66ef6f5d841..487f47696e08894a719cb14db647d3fa4ff855c5 100644 (file)
@@ -293,7 +293,7 @@ img {
 <body>\r
 <h1>Definition of Done for Simantics Platform Releases</h1>\r
 <ol>\r
-<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
+<li>All Git repositories that are part of the Simantics release train have a branch called <code>release/x.y.z[.w]</code> and tag called <code>x.y.z[.w]</code>.</li>\r
 <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
 <li><a href="http://dev.simantics.org/index.php/Roadmap">Roadmap</a> is up-to-date.</li>\r
 <li><a href="http://dev.simantics.org/index.php/Tutorials">Tutorials</a> are up-to-date and coherent with the platform.</li>\r
@@ -322,6 +322,11 @@ img {
 <h1>Released Plug-in Components and Products</h1>\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>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
+</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
@@ -354,19 +359,25 @@ img {
 <hr />\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 <code>simantics/platform</code> and <code>simantics/third-party</code> repositories:</p>\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
 cd platform\r
 git branch release/x.y.z[.w] &lt;commit&gt;\r
 git push origin release/x.y.z[.w]\r
-\r
-git clone ssh://&lt;user&gt;@www.simantics.org:29418/simantics/third-party.git\r
-cd third-party\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
+<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
+<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>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 push\r
+</code></pre>\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 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
@@ -407,7 +418,7 @@ location &quot;http://www.simantics.org/download/release/x.y.z[.w]/sdk&quot; {
       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/platform.git;a=commit;h=bab5c9bd68277c76dc5c20bc7a60a9896cbd1540">gitweb</a>.</p>\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
 </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
@@ -427,7 +438,13 @@ 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
-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
+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
+<ul>\r
+<li>Simantics Desktop splash screen update (version number)</li>\r
+<li>Simantics target platform name to state correct development version</li>\r
+<li>org.simantics.sdk feature version bump</li>\r
+<li>org.simantics.sdk.repository project version bump</li>\r
+</ul>\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
@@ -454,13 +471,14 @@ refs #yyyy
 <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
+<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
 <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
@@ -513,6 +531,7 @@ git push origin --tags
 Only annotated or signed tags can be pushed to Gerrit.</p>\r
 </blockquote>\r
 <h2>Backup documentation wiki databases</h2>\r
+<p><strong>NOTE: This step is now deprecated since we are in the process of moving all mediawiki-based documentation into the platform git repository.</strong></p>\r
 <p>This step is only necessary for major/minor releases, not for service releases.</p>\r
 <p>The wiki databases to be backed up are:</p>\r
 <ul>\r
index 93796ce1436fb66a5691fd377f8187ba1f0d4f84..36f86cd0c3cc6f1b583721c88d0bd472139a61c6 100644 (file)
@@ -1,6 +1,6 @@
 # Definition of Done for Simantics Platform Releases
 
-1. The `simantics/platform` and `simantics/third-party` Git repositories have a branch `release/x.y.z[.w]` and tag `x.y.z[.w]`.
+1. All Git repositories that are part of the Simantics release train have a branch called `release/x.y.z[.w]` and tag called `x.y.z[.w]`.
 2. [A change log entry](https://www.simantics.org/redmine/projects/simantics-platform/wiki/ChangeLog) 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.
 3. [Roadmap](http://dev.simantics.org/index.php/Roadmap) is up-to-date.
 4. [Tutorials](http://dev.simantics.org/index.php/Tutorials) are up-to-date and coherent with the platform.
@@ -28,6 +28,10 @@ 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:
+* 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
+
 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)
@@ -60,21 +64,31 @@ For simplicity, each of these components are versioned accoring to platform vers
 
 ## Create release branch from selected commit
 
-When release stabilisation starts, branch `simantics/platform` and `simantics/third-party` repositories:
+When release stabilisation starts, branch all relevant repositories like this:
 
     git clone ssh://<user>@www.simantics.org:29418/simantics/platform.git
     cd platform
     git branch release/x.y.z[.w] <commit>
     git push origin release/x.y.z[.w]
 
-    git clone ssh://<user>@www.simantics.org:29418/simantics/third-party.git
-    cd third-party
-    git branch release/x.y.z[.w] <commit>
-    git push origin release/x.y.z[.w]
-
 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:
+
+    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:
+
+    ./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.
+
+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 push
+
 ## 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.
@@ -121,7 +135,7 @@ In the following steps, it is recommended to ensure every `.target` file is up-t
          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/platform.git;a=commit;h=bab5c9bd68277c76dc5c20bc7a60a9896cbd1540).
+   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/).
 
 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.
 
@@ -140,7 +154,11 @@ In the following steps, it is recommended to ensure every `.target` file is up-t
         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/platform.git;a=commitdiff;h=ae93c9930c6345c32219e6845b9e72e9d9d2d28c).
+   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:
+   * Simantics Desktop splash screen update (version number)
+   * Simantics target platform name to state correct development version
+   * org.simantics.sdk feature version bump
+   * org.simantics.sdk.repository project version bump 
 
    Commit the changes with the following commit message
 
@@ -165,9 +183,9 @@ After this, whenever changes are pushed/merged to `release/x.y.z[.w]` branch in
 
 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 `.target` files
+### Update release-branch `.target` files
 
-Lastly, we want to change the `.target` files to point to the correct P2 repository locations. This happens by opening the previously edited `.tpd` files in Obeo's editor and regenerating the `.target` files by pressing Alt+R.
+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:
 
@@ -175,6 +193,8 @@ Push the changed files to remote again with commit message:
 
     refs #xxxx
 
+See [review 1361](https://www.simantics.org:8088/r/#/c/1361) for an example.
+
 ### 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
@@ -222,6 +242,8 @@ When the release branches are ready for the release, tag them with the tag `vx.y
 
 ## Backup documentation wiki databases
 
+**NOTE: This step is now deprecated since we are in the process of moving all mediawiki-based documentation into the platform git repository.** 
+
 This step is only necessary for major/minor releases, not for service releases.
 
 The wiki databases to be backed up are: