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:
git clone ssh://<user>@www.simantics.org:29418/simantics/platform.git
+When release stabilisation starts, branch all relevant repositories like this:
+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]
-
-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.
+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
+
+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
-Prepare .target files
-
+In release 1.31.0 Simantics started using 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.
+Prepare .tpd files in platform repository
+
-
-
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]
+Ensure you've ran
+./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.
-
-
Edit all target platform files in releng/org.simantics.sdk.build.targetdefinition/, i.e.
+Go into the cloned platform repository at x.y.z/platform
+
+-
+
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.tpd
-At 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"/>
+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" {
-
-Initialize release branch distribution web site
-
-- Run SDK/Deploy External Components to Web build with parameters:
+
-
+
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
+or review 1361.
+
+-
+
Ensure that Gitlab has a release engineering issue for the branched release,
+such as Simantics 1.34.0 release engineering
-- GERRIT_REFNAME:
release/x.y.z[.w]
-- PUBLISH_ARTIFACTS:
true
+- 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
-- Run the SDK/Simantics SDK build with parameters:
+
+
+-
+
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]
+
+
+-
+
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 or in review 1362. The changes include:
-- GERRIT_REFNAME:
release/x.y.z[.w]
-- PUBLISH_ARTIFACTS:
true
+- 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.
+
+-
+
Do the same for simupedia target platform files as was done in task 6.
+for platform target definitions.
+
+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
-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.
+to ensure that all components of the release train build fine and to publish first versions of P2 repositories of everything online.
+The release train build is currently never ran automatically.
+However, after following all these steps, whenever changes are pushed/merged to release/x.y.z[.w] branch in Gerrit, new Jenkins builds are triggered automatically and they will publish the results (P2 repositories/products) at their designated locations online.
+[Optional reading] Release train build details
+The release train build does two very important steps as the first things,
+i.e. build the external dependency P2 repositories for both the
+Platform SDK and Simupedia:
+stage('External Dependencies') {
+ node {
+ build job: 'SDK/Deploy External Components to Web', parameters: params1
+ build job: 'Member Components/Simupedia/fi.semantum.simupedia.build.p2.site', parameters: params1
+ }
+}
+
+After that it builds the Platform SDK and Simupedia before building anything else:
+stage('SDK') {
+ node {
+ build job: 'SDK/Simantics SDK', parameters: params1
+ // Note that Simantics SDK builds simupedia-git as well
+ }
+}
+
Review documentation
Documentation to review:
@@ -438,23 +538,17 @@ git checkout release/x.y.z[.w]
Tag release/* branches
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
+./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 pull
+./release-helper.sh x.y.z release/x.y.z your-git-username tag
+./release-helper.sh x.y.z release/x.y.z your-git-username push-tags
-Note The -m argument must be supplied to create an annotated tag.
+
Note: release-helper.sh will supply the -m argument to git tag to create an annotated tag.
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:
@@ -466,7 +560,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
separate Mediawiki installation.
-- Dump documentation wiki databases using [dump-wikis.sh](./dump-wikis.sh) script.
+- Dump documentation wiki databases using dump-wikis.sh script.
- Put the generated backup x.y.z.tar.gz at /var/backup/simantics-releases/x.y.z/wiki/
Compile change log entry
@@ -517,15 +611,15 @@ separate Mediawiki installation.
Disseminate information about the release
-- Developer Wiki: Update roadmap at http://dev.simantics.org/index.php/Roadmap
-- Redmine: Post news on the developer/user-visible changes here.
+- Developer Wiki: Update roadmap at http://dev.simantics.org/index.php/Roadmap
+- Redmine: Post news on the developer/user-visible changes here
- simantics.org: Post news on the release and a link to the redmine post
- Members Wiki: Update frame plan to reflect the realized dates and link to Redmine news
- mailto:simantics-developers@simantics.org Send "newsletter" to `simantics-developers@simantics.org:
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.
@@ -544,19 +638,7 @@ Insert some general thoughts on the release...
TODO
-- 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
-
--
-
Start using https://github.com/mbarbero/fr.obeo.releng.targetplatform to generate .target files. .tpd files allow specifying version ranges instead of specific versions.
-
+- 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