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] and tag called x.y.z[.w].There 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.
+There 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:
+Core components of the release train:
Plug-in components that are part of the release train:
Products 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:
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
+In release 1.31.0 Simantics started using uses the wonderful tool from Obeo (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.
.tpd filesRetrieve release branch of the platform repository
@@ -370,29 +394,22 @@ git checkout release/x.y.z[.w]Edit all target platform files in releng/org.simantics.sdk.build.targetdefinition/, i.e.
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.tpdsimantics.tpdAt the beginning of simantics.target file, increment sequenceNumber by 1 and replace
-the version numbers in target name and org.simantics.sdk.feature.group and
-org.simantics.sdk.source.feature.group with x.y.z[.w]:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<?pde version="3.8"?>
-<target name="Simantics x.y.z[.w]" sequenceNumber="11">
-<unit id="org.simantics.sdk.feature.group" version="x.y.z[.w]"/>
-<unit id="org.simantics.sdk.source.feature.group" version="x.y.z[.w]"/>
-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"/>
+Replace the following rows in both mentioned files:
+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
-<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"/>
+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" {
org.simantics.sdk.feature.group
-An example of these changes can be seen in gitweb.
+An example of these changes can be seen in gitweb or review 1361.
Ensure that Redmine has a release engineering issue for the branched release, such as Simantics 1.30.0 release engineering. Make a copy of the previous release issue to create the new one. Include link to original issue while copying.
@@ -423,9 +440,16 @@ the version numbers in target name andorg.simantics.sdk.feature.group
-
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.
+An example of these changes can be seen in gitweb or in review 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].
+
refs #yyyy
where #yyyy is the number of the next release's release engineering issue.
@@ -449,6 +473,21 @@ refs #yyyy
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 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.
+Update release-branch .target files
+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:
+Configured release/x.y.z[.w] branch .target files.
+
+refs #xxxx
+
+See review 1361 for an example.
+Test Release Train build
+Trigger an execution of the simantics-release-train Jenkins job with parameters
+
+- GERRIT_REFNAME:
release/x.y.z[.w]
+- PUBLISH_ARTIFACTS:
true
+
+to ensure that all components of the release train build fine and to publish first versions of P2 repositories of everything online.
Review documentation
Documentation to review:
@@ -494,6 +533,7 @@ git push origin --tags
Only annotated or signed tags can be pushed to Gerrit.
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:
@@ -583,16 +623,6 @@ Insert some general thoughts on the release...
TODO
-- Start using https://github.com/mbarbero/fr.obeo.releng.targetplatform to generate
.target files. .tpd files allow specifying version ranges instead of specific versions.
-
-
-- Create a parametrized release train pipeline build in Jenkins that creates all artifacts of a simantics release
-
-- Desktop, Sysdyn, R, Simupedia, FMIL, FMI Studio
-
-
-
-
- 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