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:
-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 creating major/minor releases <commit> is usually a commit in the master branch.
With service releases, branch from an existing release/* branch instead.
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 +381,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/master/release/x.y.z[.w]/maven" {
+location "http://www.simantics.org/download/master/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.groupgitweb.
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 +454,20 @@ 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 .target files
+Lastly, we want to change the .target files to point to the correct P2 repository locations. 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
+
+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:
@@ -583,16 +602,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