simantics/platform and simantics/third-party Git repositories have a branch release/x.y.z[.w] and tag x.y.z[.w].release/x.y.z[.w] release stabilisation branchIn the following sections each task is described step by step.
-When release stabilisation starts, branch simantics/platform and simantics/third-party repositories:
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.
Retrieve release branch of the platform repository
-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]
-Edit all target platform files in releng/org.simantics.sdk.build.targetdefinition/, i.e.
simantics.targetorg.simantics.sdk.build.targetdefinition.targetorg.simantics.sdk.build.targetdefinition-semantum.targetAt the beginning of each .target file, increment sequenceNumber by 1
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<?pde version="3.8"?>
-<target name="Simantics x.y.z[.w]" sequenceNumber="11">
-Next, replace the following rows in those files:
-<repository location="http://www.simantics.org/download/master/sdk"/>
-<repository location="http://www.simantics.org/download/master/external-components/maven"/>
-<repository location="http://www.simantics.org/download/master/external-components/manual"/>
-with
-<repository location="http://www.simantics.org/download/release/x.y.z[.w]/sdk"/>
-<repository location="http://www.simantics.org/download/release/x.y.z[.w]/external-components/maven"/>
-<repository location="http://www.simantics.org/download/release/x.y.z[.w]/external-components/manual"/>
-release/x.y.z[.w]truerelease/x.y.z[.w]trueDocumentation to review:
- -For each wiki page:
-Ensure tutorial wiki documentation at http://dev.simantics.org/index.php/Tutorials is up-to-date with the released platform
-Ensure tutorial projects and product build properly
-com.acme.movie
-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] 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] release"
-git push origin --tags
---Note The -m argument must be supplied to create an annotated tag. -Only annotated or signed tags can be pushed to Gerrit.
-
Dump documentation wiki using dump-wikis.sh script.
-The wiki documentation is mainly in MediaWiki installations. The only -sane way to tag the documentation is to back up the mysql database -backing the wiki.
-\t) with | with Regular Expressions selection checked|#|%{background: lightsalmon}Major Bug%%{background: lightgreen}Major Feature%%{background: lightgreen}Major Enhancement%Mail template:
-Hello everyone,
-
-Simantics release x.y.z[.w] has been released. Head over to
-https://www.simantics.org/redmine/news/<news number>
-for the release news.
-
-Best regards,
-Simantics Release Engineering Team
-News entry template:
-On <date> Simantics x.y.z[.w] was tagged in SVN. Please find change log at:
-* [[simantics-platform:Simantics_xyzw|Simantics x.y.z.w]]
-
-Insert some general thoughts on the release...
-.target files. .tpd files allow specifying version ranges instead of specific versions.simantics/platform and simantics/third-party Git repositories have a branch release/x.y.z[.w] and tag x.y.z[.w].release/x.y.z[.w] release stabilisation branchThere are both plug-in components and products that are part of the "Simantics release train" that shall be released simultaneously to a major or minor Simantics release.
+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.
+Products that are part of the release train:
+Plug-in components that are part of the release train:
+For simplicity, each of these components are versioned accoring to platform versioning, i.e. for Platform SDK 1.26.0 there will be Simantics Desktop 1.26.0, Sysdyn 1.26.0, and so on.
+When release stabilisation starts, branch simantics/platform and simantics/third-party repositories:
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.
Retrieve release branch of the platform repository
+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]
+Edit all target platform files in releng/org.simantics.sdk.build.targetdefinition/, i.e.
simantics.targetorg.simantics.sdk.build.targetdefinition.targetAt the beginning of simantics.target file, increment sequenceNumber by 1
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<?pde version="3.8"?>
+<target name="Simantics x.y.z[.w]" sequenceNumber="11">
+Next, replace the following rows in both mentioned files:
+<repository location="http://www.simantics.org/download/master/sdk"/>
+<repository location="http://www.simantics.org/download/master/external-components/maven"/>
+<repository location="http://www.simantics.org/download/master/external-components/manual"/>
+with
+<repository location="http://www.simantics.org/download/release/x.y.z[.w]/sdk"/>
+<repository location="http://www.simantics.org/download/release/x.y.z[.w]/external-components/maven"/>
+<repository location="http://www.simantics.org/download/release/x.y.z[.w]/external-components/manual"/>
+release/x.y.z[.w]truerelease/x.y.z[.w]trueRunning 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 Jenkins job.
+Documentation to review:
+ +For each wiki page:
+Ensure tutorial wiki documentation at http://dev.simantics.org/index.php/Tutorials is up-to-date with the released platform
+Ensure tutorial projects and product build properly
+com.acme.movie
+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] 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] release"
+git push origin --tags
+++Note The -m argument must be supplied to create an annotated tag. +Only annotated or signed tags can be pushed to Gerrit.
+
This step is only necessary for major/minor releases, not for service releases.
+The wiki databases to be backed up are:
+ +These are MediaWiki installations. The only sane way to "tag" the documentation +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.
+\t) with | with Regular Expressions selection checked|#|%{background: lightsalmon}Major Bug%%{background: lightgreen}Major Feature%%{background: lightgreen}Major Enhancement%Newsletter template:
+Hello everyone,
+
+Simantics release x.y.z[.w] has been released. Head over to
+https://www.simantics.org/redmine/news/<news number>
+for the release news.
+
+Best regards,
+Simantics Release Engineering Team
+Redmine news template:
+Title: Simantics x.y.z[.w] released
+
+Simantics x.y.z[.w] was released on <date>.
+Please find change log at: [[simantics-platform:Simantics_xyzw|Simantics x.y.z[.w]]]
+
+Insert some general thoughts on the release...
+Incorporate tutorial code in the platform repository as a separate folder to allow platform builds to directly ensure that the tutorial code still builds OK
+Start using https://github.com/mbarbero/fr.obeo.releng.targetplatform to generate .target files. .tpd files allow specifying version ranges instead of specific versions.