Minor wording update to release engineering instructions.

[simantics/platform.git] / releng / doc / release.html

diff --git a/releng/doc/release.html b/releng/doc/release.html
index 1ede770874c0492dbb73f6ecf834d1fe01a7aeb5..17c7d28f45016120cb6736611260a8f2e648e55a 100644 (file)
--- a/releng/doc/release.html
+++ b/releng/doc/release.html
@@ -375,10 +375,14 @@ git checkout release/x.y.z[.w]
 <li><code>simantics.target</code></li>\r
 <li><code>org.simantics.sdk.build.targetdefinition.target</code></li>\r
 </ul>\r
-<p>At the beginning of simantics.target file, increment <code>sequenceNumber</code> by 1</p>\r
+<p>At the beginning of simantics.target file, increment <code>sequenceNumber</code> by 1 and replace\r
+the version numbers in target name and <code>org.simantics.sdk.feature.group</code> and\r
+<code>org.simantics.sdk.source.feature.group</code> with <code>x.y.z[.w]</code>:</p>\r
 <pre><code>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;no&quot;?&gt;\r
 &lt;?pde version=&quot;3.8&quot;?&gt;\r
 &lt;target name=&quot;Simantics x.y.z[.w]&quot; sequenceNumber=&quot;11&quot;&gt;\r
+&lt;unit id=&quot;org.simantics.sdk.feature.group&quot; version=&quot;x.y.z[.w]&quot;/&gt;\r
+&lt;unit id=&quot;org.simantics.sdk.source.feature.group&quot; version=&quot;x.y.z[.w]&quot;/&gt;\r
 </code></pre>\r
 <p>Next, replace the following rows in both mentioned files:</p>\r
 <pre><code>&lt;repository location=&quot;http://www.simantics.org/download/master/sdk&quot;/&gt;\r
@@ -391,6 +395,41 @@ git checkout release/x.y.z[.w]
 &lt;repository location=&quot;http://www.simantics.org/download/release/x.y.z[.w]/external-components/manual&quot;/&gt;\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>&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/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
+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
 <ul>\r
@@ -441,13 +480,13 @@ git checkout release/x.y.z[.w]
 <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] release&quot;\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] release&quot;\r
+git tag vx.y.z[.w] -m &quot;Simantics x.y.z[.w] simultaneous release&quot;\r
 git push origin --tags\r
 </code></pre>\r
 <blockquote>\r
@@ -466,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\r
 separate Mediawiki installation.</p>\r
 <ol>\r
-<li>Dump documentation wiki databases using [dump-wikis.sh](./dump-wikis.sh) script.</li>\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