Merge "Multiple reader thread support for db client"
authorTuukka Lehtonen <tuukka.lehtonen@semantum.fi>
Fri, 3 Aug 2018 05:23:49 +0000 (05:23 +0000)
committerGerrit Code Review <gerrit2@simantics>
Fri, 3 Aug 2018 05:23:49 +0000 (05:23 +0000)
bundles/org.simantics.desktop.product/splash.bmp
bundles/org.simantics.desktop.product/splash.svg
features/org.simantics.sdk.feature/feature.xml
releng/doc/release-helper.sh
releng/doc/release.html
releng/doc/release.md
releng/org.simantics.sdk.build.targetdefinition/simantics.target
releng/org.simantics.sdk.build.targetdefinition/simantics.tpd
releng/org.simantics.sdk.repository/pom.xml

index ee5557af41d1b7346d1ea69a358a647c5509e5e6..e01916ac6d8844c18b6b8216eac954ca76fa8066 100644 (file)
Binary files a/bundles/org.simantics.desktop.product/splash.bmp and b/bundles/org.simantics.desktop.product/splash.bmp differ
index f276c2118d8b06ebad3663317b2915be00bd172c..fe5ca08a2e60fad0b8017b772e944d63c1805bc3 100644 (file)
          id="tspan6235"
          x="4.0821486"
          y="291.79337"
-         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:5.64444447px;font-family:'The Real Font';-inkscape-font-specification:'The Real Font';fill:#ffffff;fill-opacity:1;stroke-width:0.26458335px">1.35.0</tspan></text>
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:5.64444447px;font-family:'The Real Font';-inkscape-font-specification:'The Real Font';fill:#ffffff;fill-opacity:1;stroke-width:0.26458335px">1.36.0</tspan></text>
     <circle
        style="opacity:0.92900002;fill:#5d6b91;fill-opacity:1;stroke:none;stroke-width:1.27400005;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;filter:url(#filter6809)"
        id="path6231"
index 090d11f21c1d37c79adb09fac10290bc4680c278..00a3b68b0b76ea00f607b6e80c0e112e51d324ad 100644 (file)
@@ -13,7 +13,7 @@
 <feature
       id="org.simantics.sdk"
       label="Simantics SDK"
-      version="1.35.0.qualifier"
+      version="1.36.0.qualifier"
       provider-name="VTT Technical Research Centre of Finland">
 
    <description url="http://www.example.com/description">
index cbd4f6206407c51575edba60311d798cf636c34b..6e56cb55ea3e076c03118c668548f5bc1a406baa 100755 (executable)
@@ -1,11 +1,18 @@
 #!/bin/bash
 
+selfdir=$(dirname $(readlink -f $0))
 self=`basename $0`
+selfpath=$selfdir/$self
 version=$1
+version_xyz=`echo $version | awk 'BEGIN { FS="." } { printf("%d.%d.%d", $1, $2, $3); }'`
 branch=$2
 user=$3
 action=$4
 tagForVersion=v${version}
+shift 4
+
+rundir=`pwd`
+versiondir=$rundir/$version
 
 ###############################################################################
 
@@ -35,6 +42,10 @@ function localPath {
        eval $1=\${repositories[$(($2 * 2 + 1))]}
 }
 
+function version_xyz {
+       echo $version
+}
+
 ###############################################################################
 
 function msg {
@@ -46,11 +57,21 @@ function clone {
        git clone ssh://${user}@www.simantics.org:29418/$1
 }
 
+function add {
+       echo "git add $@"
+       git add $@
+}
+
 function branch {
        echo "git branch $1"
        git branch $1
 }
 
+function commit {
+       echo "git commit $@"
+       git commit $@
+}
+
 function fetch {
        echo "git fetch --all"
        git fetch --all
@@ -87,7 +108,15 @@ function pushTags {
 }
 
 function status {
-       git status
+       git status $@
+}
+
+function diff {
+       git diff --stat --patch $@
+}
+
+function log {
+       git log --pretty --oneline --graph --decorate=full $@
 }
 
 function listTags {
@@ -98,6 +127,39 @@ function listBranches {
        git branch -a
 }
 
+function repl {
+       local from=$1
+       local to=$2
+       shift 2
+       for i in $@; do
+               echo "Replacing $from' with '$to' in file $i"
+               cat $i | awk "{ gsub(\"$from\", \"$to\"); print }" > $i.tmp
+               mv $i.tmp $i
+       done
+}
+
+function bumpSequenceNumber {
+       echo "bumpSequenceNumber '$1'"
+       cat $i | awk '
+BEGIN {
+       regex="sequenceNumber=\"[0-9]+\"";
+       cmd = "date +%s"
+       cmd | getline epoch
+       close(cmd)
+}
+{
+       if (match($0, regex)) {
+               before = substr($0,1,RSTART-1);
+               after = substr($0,RSTART+RLENGTH);
+               printf("%ssequenceNumber=\"%s\"%s\n", before, epoch, after);
+       } else {
+               print;  
+       }
+}
+' > $i.tmp
+       mv $i.tmp $i
+}
+
 ###############################################################################
 
 case "$action" in
@@ -115,10 +177,22 @@ case "$action" in
 esac
 
 if [ -n "$version" ] && [ -d $version ]; then
-       pushd $version > /dev/null
+       pushd $version >/dev/null || action="*"
+elif [ -n "$version" ]; then
+       # The directory does not exist yet so don't do anything
+       action="*"
 fi
 
 case "$action" in
+       add)
+               for (( i=0; i<${repositoryCount}; i++ )); do
+                       localPath lp $i
+                       msg $i "Stage changes in $lp"
+                       pushd $lp > /dev/null
+                       add $@
+                       popd > /dev/null
+               done
+       ;;
        branch)
                for (( i=0; i<${repositoryCount}; i++ )); do
                        localPath lp $i
@@ -137,6 +211,15 @@ case "$action" in
                        popd > /dev/null
                done
        ;;
+       commit)
+               for (( i=0; i<${repositoryCount}; i++ )); do
+                       localPath lp $i
+                       msg $i "Checkout $branch branch in $lp"
+                       pushd $lp > /dev/null
+                       commit $@
+                       popd > /dev/null
+               done
+       ;;
        tag)
                for (( i=0; i<${repositoryCount}; i++ )); do
                        localPath lp $i
@@ -215,15 +298,149 @@ case "$action" in
                        localPath lp $i
                        msg $i "Status of $lp"
                        pushd $lp > /dev/null
-                       status
+                       status $@
                        popd > /dev/null
                done
        ;;
-       *)
-               echo "Usage: ${self} <version> <branch-name> <user-name> clone|branch|checkout|fetch|list-tags|pull|push|push-tags|remove-tag|status|tag"
-               if [ -d $version ]; then
-                       echo "Version directory ('$version') does not exist yet. Please run the 'clone' action first."
-               fi
+       diff)
+               for (( i=0; i<${repositoryCount}; i++ )); do
+                       localPath lp $i
+                       msg $i "Diff $branch branch in $lp"
+                       pushd $lp > /dev/null
+                       diff $@
+                       popd > /dev/null
+               done
+       ;;
+       log)
+               for (( i=0; i<${repositoryCount}; i++ )); do
+                       localPath lp $i
+                       msg $i "Log of $lp"
+                       pushd $lp > /dev/null
+                       log $@
+                       popd > /dev/null
+               done
+       ;;
+       reset)
+               for (( i=0; i<${repositoryCount}; i++ )); do
+                       localPath lp $i
+                       msg $i "'git reset $@' in $lp"
+                       pushd $lp > /dev/null
+                       git reset $@
+                       popd > /dev/null
+               done
+       ;;
+       
+       prepare-release-branch)
+               fromBranch=$1
+               
+               # Fix branch name from P2 repository locations
+               for i in platform/releng/org.simantics.sdk.build.targetdefinition/*.{tpd,target} \
+                       simupedia/fi.semantum.simupedia.build.targetdefinition/*.{tpd,target}
+               do
+                       repl "/$fromBranch/" "/$branch/" $i
+               done
+       
+               # Bump .target file sequenceNumbers
+               for i in platform/releng/org.simantics.sdk.build.targetdefinition/*.target \
+                       simupedia/fi.semantum.simupedia.build.targetdefinition/*.{tpd,target}
+               do
+                       bumpSequenceNumber $i
+               done
+
+               pushd platform
+               git commit -a -m "Configured $branch branch for SDK builds"
+               git commit --amend
+               popd
 
+               pushd simupedia
+               git commit -a -m "Configured $branch branch for SDK builds"
+               git commit --amend
+               popd
        ;;
+
+       bump-master-version)
+               fromVersion=$1
+               toVersion=$2
+
+               bash $selfpath $version master $user checkout
+
+               repl "$fromVersion" "$toVersion" platform/bundles/org.simantics.desktop.product/splash.svg
+               repl "$fromVersion" "$toVersion" platform/features/org.simantics.sdk.feature/feature.xml
+               repl "$fromVersion" "$toVersion" platform/releng/org.simantics.sdk.repository/pom.xml
+               repl "Simantics $fromVersion" "Simantics $toVersion" platform/releng/org.simantics.sdk.build.targetdefinition/simantics.{tpd,target}
+               repl "Simupedia $fromVersion" "Simupedia $toVersion" simupedia/fi.semantum.simupedia.build.targetdefinition/*.{tpd,target}
+               repl "Simupedia SDK $fromVersion" "Simupedia SDK $toVersion" simupedia/fi.semantum.simupedia.build.targetdefinition/*.{tpd,target}
+
+               pushd platform
+               git commit -a -m "Bumped master version to $toVersion"
+               git commit --amend
+               popd
+
+               pushd simupedia
+               git commit -a -m "Bumped master version to $toVersion"
+               git commit --amend
+               popd
+       ;;
+
+       branch-release)
+               fromBranch=$1
+               popd > /dev/null
+               bash $selfpath $version $fromBranch $user checkout
+               bash $selfpath $version $branch $user branch
+               bash $selfpath $version $branch $user checkout
+               bash $selfpath $version $branch $user prepare-release-branch $fromBranch
+               #$selfpath $version $branch $user push
+       ;;
+
+       *)
+               if [ "$version" ] && [ ! -d $versiondir ]; then
+                       echo -e "Version directory ('$versiondir') does not exist yet. Run 'clone' action first.\n"
+               fi
+               echo "Usage: ${self} <version> <branch-name> <user-name> <command> [<command-arguments>]"
+               echo ""
+               echo "Commands:"
+               echo "    clone                The first thing that needs to be done before anything else"
+               echo "                         Clones all platform repositories under directory <version>"
+               echo ""
+               echo "Inspection commands:"
+               echo "    diff [args]          Run git diff [args] for each platform repository"
+               echo "    log [args]           Run git log [args] for each platform repository"
+               echo "    status [args]        Run git status [args] for each platform repository"
+               echo "    list-tags            Run git tag -l for each repository"
+               echo ""
+               echo "Action:"
+               echo "    add                  "
+               echo "    branch               Run git branch <branch-name> for each platform repository"
+               echo "    checkout             Run git checkout <branch-name> for each repository"
+               echo "    commit               "
+               echo "    fetch                Run git fetch --all for each repository"
+               echo "    pull                 Run git pull --all for each repository"
+               echo "    push                 Run git push origin <branch> for each repository"
+               echo "    push-tags            Run git push --tags for each repository"
+               echo "    remove-tag           Run git tag -d v<branch> for each repository"
+               echo "    reset [args]         Run git reset [args] for each repository"
+               echo "    tag                  Run git checkout <branch> and"
+               echo "                         git tag -a v<branch> -m \"Simantics <branch> simultaneous release\""
+               echo "                         for each repository"
+               echo ""
+               echo "Compound release commands:"
+               echo "    prepare-release-branch <from-branch>"
+               echo "        <from-branch>    the name of the branch that the codebase is currently on"
+               echo ""
+               echo "Top-level release commands:"
+               echo "    bump-master-version <from-version> <to-version>"
+               echo "        <from-version>   the version string to replace"
+               echo "        <to-version>     the replacing new version string"
+               echo ""
+               echo "    branch-release <from-branch>"
+               echo "        <from-branch>    the branch to create the service branch from"
+               echo "                         e.g. master or release/x.y.z"
+               echo ""
+               echo "Processed repositories:"
+               for (( i=0; i<${repositoryCount}; i++ )); do
+                       repo p $i
+                       msg $i "$p"
+               done
+       
+;;
 esac
index 222857de043939870404d944ae84ccbfde0c5eb4..2fe58386a07edf9e90e13931946dd776be597215 100644 (file)
@@ -360,84 +360,7 @@ img {
 </ul>\r
 <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 all relevant repositories like this:</p>\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
-<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
-<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
-<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
-./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
-<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
-<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
-<h3>Prepare <code>.tpd</code> files in platform repository</h3>\r
-<ol start="0">\r
-<li>\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
-<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
-<ul>\r
-<li><code>org.simantics.sdk.build.targetdefinition.tpd</code></li>\r
-<li><code>simantics.tpd</code></li>\r
-</ul>\r
-<p>Replace the following rows in both mentioned files:</p>\r
-<pre><code>location &quot;http://www.simantics.org/download/master/external-components/maven&quot; {\r
-location &quot;http://www.simantics.org/download/master/external-components/manual&quot; {\r
-include &quot;http://www.simantics.org/download/master/org.simantics.sdk.build.targetdefinition.tpd&quot;\r
-location &quot;http://www.simantics.org/download/master/sdk&quot; {\r
-</code></pre>\r
-<p>with</p>\r
-<pre><code>location &quot;http://www.simantics.org/download/release/x.y.z[.w]/maven&quot; {\r
-location &quot;http://www.simantics.org/download/release/x.y.z[.w]/manual&quot; {\r
-include &quot;http://www.simantics.org/download/release/x.y.z[.w]/org.simantics.sdk.build.targetdefinition.tpd&quot;\r
-location &quot;http://www.simantics.org/download/release/x.y.z[.w]/sdk&quot; {\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</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>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
+<h2>Create release engineering issue(s) in Gitlab</h2>\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
@@ -445,43 +368,91 @@ such as <a href="https://gitlab.simantics.org/simantics/platform/issues/16">Sima
 <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
-</ol>\r
-<ol start="5">\r
-<li>\r
-<p>Commit the changes made</p>\r
-<pre><code> git commit -a\r
+<h2>Create release branch from selected commit</h2>\r
+<p>When release stabilisation starts, all relevant repositories need to be branched.\r
+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>Instead of doing this clone+branch+push sequence for every SDK repository separately, please use the included <code>release-helper.sh</code> shell script to perform this mechanical work.\r
+The script supports many useful basic git commands which all perform the requested operation on all the release train repositories.\r
+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; &lt;command&gt; [&lt;command-arguments&gt;]\r
+\r
+Commands:\r
+    clone                The first thing that needs to be done before anything else\r
+                         Clones all platform repositories under directory &lt;version&gt;\r
+\r
+Inspection commands:\r
+    diff [args]          Run git diff [args] for each platform repository\r
+    log [args]           Run git log [args] for each platform repository\r
+    status [args]        Run git status [args] for each platform repository\r
+    list-tags            Run git tag -l for each repository\r
+\r
+Action:\r
+    add\r
+    branch               Run git branch &lt;branch-name&gt; for each platform repository\r
+    checkout             Run git checkout &lt;branch-name&gt; for each repository\r
+    commit\r
+    fetch                Run git fetch --all for each repository\r
+    pull                 Run git pull --all for each repository\r
+    push                 Run git push origin &lt;branch&gt; for each repository\r
+    push-tags            Run git push --tags for each repository\r
+    remove-tag           Run git tag -d v&lt;branch&gt; for each repository\r
+    reset [args]         Run git reset [args] for each repository\r
+    tag                  Run git checkout &lt;branch&gt; and\r
+                         git tag -a v&lt;branch&gt; -m &quot;Simantics &lt;branch&gt; simultaneous release&quot;\r
+                         for each repository\r
+\r
+Compound release commands:\r
+    prepare-release-branch &lt;from-branch&gt;\r
+        &lt;from-branch&gt;    the name of the branch that the codebase is currently on\r
+\r
+Top-level release commands:\r
+    bump-master-version &lt;from-version&gt; &lt;to-version&gt;\r
+        &lt;from-version&gt;   the version string to replace\r
+        &lt;to-version&gt;     the replacing new version string\r
+\r
+    branch-release &lt;from-branch&gt;\r
+        &lt;from-branch&gt;    the branch to create the service branch from\r
+                         e.g. master or release/x.y.z\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
- gitlab #xxxx\r
+<p>Begin by cloning all the repositories for working on</p>\r
+<pre><code>user=&lt;your-git-username&gt;\r
+version=x.y.z\r
+branch=release/x.y.z\r
+./release-helper.sh $version $branch $user clone\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
+<p>This will create a directory called <code>x.y.z</code> under the current working directory and clone all the repositories under it.\r
+The first <code>version</code> argument is only used for the base working directory <code>x.y.z</code>.\r
+The second <code>branch</code> argument tells what branch to specify to some of the available actions, e.g. <code>branch</code>, <code>checkout</code>, etc.</p>\r
+<p>Creating the release branch from master and pushing the new branches to remote happens as follows:</p>\r
+<pre><code># When the commit messages appear, add references to created\r
+# Gitlab release engineering issues by adding this to the commit message:\r
+# \r
+# gitlab #xxxx\r
+#\r
+# where xxxx is the release engineering issue for the respective project\r
+./release-helper.sh $version $branch $user branch-release master\r
+./release-helper.sh $version $branch $user push\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://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
+<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>fromBranch=release/x.y.z\r
+branch=release/x.y.w\r
+./release-helper.sh $version $branch $user branch-release $fromBranch\r
+./release-helper.sh $version $branch $user push\r
+</code></pre>\r
+<p>If you branched a new release from <code>master</code>, you should also bump the revision of the master branch right now to start the next release cycle in master.\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>.\r
+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
-gitlab #yyyy\r
+<p>Perform and push the changes by running:</p>\r
+<pre><code>./release-helper.sh $version $branch $user bump-master-version 1.35.0 1.36.0\r
+./release-helper.sh $version $branch $user push\r
 </code></pre>\r
-<p>where <code>#yyyy</code> is the number of the next release's release engineering issue.</p>\r
-</li>\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
-</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
index da394696c63940af28905684b045a2d00916d41d..e3749dccf6a420abc84bf6279d2cb75b3a22915a 100644 (file)
@@ -29,8 +29,8 @@ 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://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
+* 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)
+* The Simantics Platform - [simantics/platform.git](https://gerrit.simantics.org/r/gitweb?p=simantics/platform.git;a=summary)
 
 Plug-in components that are part of the release train:
 * Simupedia - [members/simupedia.git](https://gerrit.simantics.org/r/gitweb?p=members/simupedia.git;a=summary)
@@ -64,136 +64,107 @@ For simplicity, each of these components are versioned accoring to platform vers
 
 # Simantics Platform Release - Step by Step
 
-## Create release branch from selected commit
+## Create release engineering issue(s) in Gitlab
 
-When release stabilisation starts, branch all relevant repositories like this:
+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
 
-    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]
+## Create release branch from selected commit
 
+When release stabilisation starts, all relevant repositories need to be branched.
 When creating major/minor releases `<commit>` is usually a commit in the `master` branch.
 With service releases, branch from an existing `release/*` branch instead.
 
-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
-
-Always begin by cloning all the repositories for working on 
-
-    ./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. 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
-    ./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
+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> <command> [<command-arguments>]
+
+Commands:
+    clone                The first thing that needs to be done before anything else
+                         Clones all platform repositories under directory <version>
+
+Inspection commands:
+    diff [args]          Run git diff [args] for each platform repository
+    log [args]           Run git log [args] for each platform repository
+    status [args]        Run git status [args] for each platform repository
+    list-tags            Run git tag -l for each repository
+
+Action:
+    add
+    branch               Run git branch <branch-name> for each platform repository
+    checkout             Run git checkout <branch-name> for each repository
+    commit
+    fetch                Run git fetch --all for each repository
+    pull                 Run git pull --all for each repository
+    push                 Run git push origin <branch> for each repository
+    push-tags            Run git push --tags for each repository
+    remove-tag           Run git tag -d v<branch> for each repository
+    reset [args]         Run git reset [args] for each repository
+    tag                  Run git checkout <branch> and
+                         git tag -a v<branch> -m "Simantics <branch> simultaneous release"
+                         for each repository
+
+Compound release commands:
+    prepare-release-branch <from-branch>
+        <from-branch>    the name of the branch that the codebase is currently on
+
+Top-level release commands:
+    bump-master-version <from-version> <to-version>
+        <from-version>   the version string to replace
+        <to-version>     the replacing new version string
+
+    branch-release <from-branch>
+        <from-branch>    the branch to create the service branch from
+                         e.g. master or release/x.y.z
+```
+
+Begin by cloning all the repositories for working on 
+
+    user=<your-git-username>
+    version=x.y.z
+    branch=release/x.y.z
+    ./release-helper.sh $version $branch $user clone
+
+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` argument tells what branch to specify to some of the available actions, e.g. `branch`, `checkout`, etc.
+
+Creating the release branch from master and pushing the new branches to remote happens as follows:
+
+    # When the commit messages appear, add references to created
+    # Gitlab release engineering issues by adding this to the commit message:
+    # 
+    # gitlab #xxxx
+    #
+    # where xxxx is the release engineering issue for the respective project
+    ./release-helper.sh $version $branch $user branch-release master
+    ./release-helper.sh $version $branch $user 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
-
-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.
-
-### 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
-
-   to make sure you're working on the release branch before doing anything.
-
-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`
-   * `simantics.tpd`
-
-   Replace the following rows in both mentioned files:
+    fromBranch=release/x.y.z
+    branch=release/x.y.w
+    ./release-helper.sh $version $branch $user branch-release $fromBranch
+    ./release-helper.sh $version $branch $user push
 
-   ~~~
-   location "http://www.simantics.org/download/master/external-components/maven" {
-   location "http://www.simantics.org/download/master/external-components/manual" {
-   include "http://www.simantics.org/download/master/org.simantics.sdk.build.targetdefinition.tpd"
-   location "http://www.simantics.org/download/master/sdk" {
-   ~~~
-
-   with
-
-   ~~~
-   location "http://www.simantics.org/download/release/x.y.z[.w]/maven" {
-   location "http://www.simantics.org/download/release/x.y.z[.w]/manual" {
-   include "http://www.simantics.org/download/release/x.y.z[.w]/org.simantics.sdk.build.targetdefinition.tpd"
-   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`.
-   ~~~
-   <feature
-         id="org.simantics.sdk"
-         label="Simantics SDK"
-         version="x.y.z"
-         provider-name="VTT Technical Research Centre of Finland">
-   ~~~
-
-   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
-
-
-5. Commit the changes made
-
-        git commit -a
-
-   with the commit message
-
-        Configured release/x.y.z[.w] branch for SDK builds.
-
-        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.
-   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:
+If you branched a new release from `master`, you should also bump the revision of the master branch right now to start the next release cycle in master.
+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
    * org.simantics.sdk.repository project version bump 
 
-   Commit the changes with the following commit message
-
-       Bumped master target and org.simantics.sdk feature versions to x.y.z[.w].
-
-       gitlab #yyyy
-
-   where `#yyyy` is the number of the next release's release engineering issue.
+Perform and push the changes by running:
 
-7. Do the same for simupedia target platform files as was done in task 6.\r
-   for platform target definitions.
+    ./release-helper.sh $version $branch $user bump-master-version 1.35.0 1.36.0
+    ./release-helper.sh $version $branch $user push
 
 ### Test Release Train build
 
index 710b1d053433f00c07b5267e227cfb3f6d4b197c..dadc7de88d00ea82c0c174c8184c9852acdd06b8 100644 (file)
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>\r
 <?pde?>\r
 <!-- generated with https://github.com/mbarbero/fr.obeo.releng.targetplatform -->\r
-<target name="Simantics 1.35.0" sequenceNumber="1521648757">\r
+<target name="Simantics 1.36.0" sequenceNumber="1521648757">\r
   <locations>\r
     <location includeMode="slicer" includeAllPlatforms="true" includeSource="true" includeConfigurePhase="false" type="InstallableUnit">\r
       <unit id="com.google.guava" version="21.0.0.v20170206-1425"/>\r
index 7d3fde530b7f675d13c03888cbad43630a3c54dd..d6717ff27748dbe48b49651326e2cdcbc8dec570 100644 (file)
@@ -1,4 +1,4 @@
-target "Simantics 1.35.0"
+target "Simantics 1.36.0"
 
 with source allEnvironments
 
index c45517c0c17cab467ab86530cfc05aed8da5e0fd..e383b94392de4dc3e70f95496b8096c7a3f58efe 100644 (file)
@@ -2,7 +2,7 @@
        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <artifactId>org.simantics.sdk.repository</artifactId>
-       <version>1.35.0-SNAPSHOT</version>
+       <version>1.36.0-SNAPSHOT</version>
        <packaging>eclipse-repository</packaging>
 
        <parent>