From 0659830f76d64f2376fdb39666a5e5ff4e11c2dd Mon Sep 17 00:00:00 2001
From: Tuukka Lehtonen <tuukka.lehtonen@semantum.fi>
Date: Thu, 1 Jun 2017 08:08:36 +0300
Subject: [PATCH] Updated release engineering documentation.

refs #7263
---
 releng/doc/release.html | 34 +++++++++++++++++++++++++++++-----
 releng/doc/release.md   | 28 ++++++++++++++++++++++++++++
 2 files changed, 57 insertions(+), 5 deletions(-)

diff --git a/releng/doc/release.html b/releng/doc/release.html
index 6f0fd9753..df0f9d70f 100644
--- a/releng/doc/release.html
+++ b/releng/doc/release.html
@@ -396,15 +396,39 @@ the version numbers in target name and <code>org.simantics.sdk.feature.group</co
 </code></pre>
 </li>
 <li>
-<p>Edit version number of `org.simantics.sdk` feature in `features/org.simantics.sdk.feature/feature.xml` to `x.y.z[.w]`.</p>
-<pre><code>
-&lt;feature
+<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>Now commit and push the changes to the release branch.</p>
+<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>
@@ -481,7 +505,7 @@ 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 [dump-wikis.sh](./dump-wikis.sh) script.</li>
+<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>
diff --git a/releng/doc/release.md b/releng/doc/release.md
index 6d55c144d..b16736e80 100644
--- a/releng/doc/release.md
+++ b/releng/doc/release.md
@@ -120,6 +120,34 @@ With service releases, branch from an existing `release/*` branch instead.
          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).
+
+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
+
+        git commit -a
+
+   with the commit message
+
+        Configured release/x.y.z[.w] branch for SDK builds.
+
+        refs #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.
+   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).
+
+   Commit the changes with the following commit message
+
+       Bumped master target and org.simantics.sdk feature versions to x.y.z[.w].
+       refs #yyyy
+
+   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:
-- 
2.43.2