# Definition of Done for Simantics Platform Releases
-1. The `simantics/platform` and `simantics/third-party` Git repositories have a branch `release/x.y.z[.w]` and tag `x.y.z[.w]`.
+1. All Git repositories that are part of the Simantics release train have a branch called `release/x.y.z[.w]` and tag called `x.y.z[.w]`.
2. [A change log entry](https://www.simantics.org/redmine/projects/simantics-platform/wiki/ChangeLog) is compiled from the issues in this release and made available to the general public separately for the platform and for the open products included in the release train.
3. [Roadmap](http://dev.simantics.org/index.php/Roadmap) is up-to-date.
4. [Tutorials](http://dev.simantics.org/index.php/Tutorials) are up-to-date and coherent with the platform.
# Released Plug-in Components and Products
-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:
-* Simantics Desktop
-* Simantics System Dynamics Tool - [simantics/sysdyn.git](https://www.simantics.org:8088/r/gitweb?p=simantics/sysdyn.git;a=summary)
+Core components of the release train:
+* External third party library dependencies required by the platform - [simantics/third-party.git](https://www.simantics.org:8088/r/gitweb?p=simantics/third-party.git;a=summary)\r
+* The Simantics Platform - [simantics/platform.git](https://www.simantics.org:8088/r/gitweb?p=simantics/platform.git;a=summary)\r
Plug-in components that are part of the release train:
-* Simantics R - [simantics/r.git](https://www.simantics.org:8088/r/gitweb?p=simantics/r.git;a=summary)
+* Simupedia - [members/simupedia.git](https://www.simantics.org:8088/r/gitweb?p=members/simupedia.git;a=summary)
* FMIL - [simantics/fmil.git](https://www.simantics.org:8088/r/gitweb?p=simantics/fmil.git;a=summary)
* FMI Studio - [members/fmi.git](https://www.simantics.org:8088/r/gitweb?p=members/fmi.git;a=summary)
-* Simupedia - [members/simupedia.git](https://www.simantics.org:8088/r/gitweb?p=members/simupedia.git;a=summary)
+* Interoperability components - [simantics/interop.git](https://www.simantics.org:8088/r/gitweb?p=simantics/interop.git;a=summary)
+* Simantics R binding - [simantics/r.git](https://www.simantics.org:8088/r/gitweb?p=simantics/r.git;a=summary)
+* Matlab SCL binding - [simantics/matlab.git](https://www.simantics.org:8088/r/gitweb?p=simantics/matlab.git;a=summary)
+* Python SCL binding - [simantics/python.git](https://www.simantics.org:8088/r/gitweb?p=simantics/python.git;a=summary)
+* Simantics System Dynamics - [simantics/sysdyn.git](https://www.simantics.org:8088/r/gitweb?p=simantics/sysdyn.git;a=summary)
+* Simantics District modelling components - [simantics/district.git](https://www.simantics.org:8088/r/gitweb?p=simantics/district.git;a=summary)
+* Simantics 3D modelling components - [simantics/3d.git](https://www.simantics.org:8088/r/gitweb?p=simantics/3d.git;a=summary)
+* Simantics Proteus toolset - [gold-members/proteus.git](https://www.simantics.org:8088/r/gitweb?p=gold-members/proteus.git;a=summary)
+
+Products that are part of the release train:
+* Simantics Desktop
+* Simantics System Dynamics Tool
+ * This is Simantics Desktop with Simantics System Dynamics Tool features installed
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.
## Create release branch from selected commit
-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
+
## Prepare release branch for use
-### Prepare .target files
+In release 1.31.0 Simantics started using uses 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
1. Retrieve release branch of the platform repository
git branch release/x.y.z[.w] remotes/origin/release/x.y.z[.w]
git checkout release/x.y.z[.w]
-2. Edit all target platform files in `releng/org.simantics.sdk.build.targetdefinition/`, i.e.
- * `simantics.target`
- * `org.simantics.sdk.build.targetdefinition.target`
+2. Edit all target platform files in `releng/org.simantics.sdk.build.targetdefinition/`, i.e.
+ * `org.simantics.sdk.build.targetdefinition.tpd`
+ * `simantics.tpd`
- At 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:
+ 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"/>
+ 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" {
~~~
3. Edit version number of `org.simantics.sdk` feature in `features/org.simantics.sdk.feature/feature.xml` to `x.y.z[.w]`.
provider-name="VTT Technical Research Centre of Finland">
~~~
- An example of these changes can be seen in [gitweb](https://www.simantics.org:8088/r/gitweb?p=simantics/platform.git;a=commit;h=bab5c9bd68277c76dc5c20bc7a60a9896cbd1540).
+ An example of these changes can be seen in [gitweb](https://www.simantics.org:8088/r/gitweb?p=simantics%2Fplatform.git;a=commit;h=5271b0faa98303225d00e6cd838d3fc52488545c) or [review 1361](https://www.simantics.org:8088/r/#/c/1361/).
4. Ensure that Redmine has a release engineering issue for the branched release, such as [Simantics 1.30.0 release engineering](https://www.simantics.org/redmine/issues/7263). Make a copy of the previous release issue to create the new one. Include link to original issue while copying.
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://www.simantics.org:8088/r/gitweb?p=simantics/platform.git;a=commitdiff;h=ae93c9930c6345c32219e6845b9e72e9d9d2d28c).
+ An example of these changes can be seen in [gitweb](https://www.simantics.org:8088/r/gitweb?p=simantics%2Fplatform.git;a=commit;h=564ac84a2949b19ce5c1c7c838b575527ec42b09) or in [review 1362](https://www.simantics.org:8088/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].
+
refs #yyyy
where `#yyyy` is the number of the next release's release engineering issue.
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](https://www.simantics.org/jenkins/job/SDK/job/Simantics%20SDK/) 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](https://www.simantics.org:8088/r/#/c/1361) for an example.
+
+### Test Release Train build
+
+Trigger an execution of the [simantics-release-train](https://www.simantics.org/jenkins/job/simantics-release-train/) Jenkins job with parameters
+* GERRIT_REFNAME: `release/x.y.z[.w]`\r
+* PUBLISH_ARTIFACTS: `true`\r
+
+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:
## 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:
# TODO
-* Start using [https://github.com/mbarbero/fr.obeo.releng.targetplatform](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
\ No newline at end of file
+* 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
Code Review / simantics / platform.git / blobdiff