----
-# Released Plug-in Components and Products
+# 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.
-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.
+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:
+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)
* Simantics R - [simantics/r.git](https://www.simantics.org:8088/r/gitweb?p=simantics/r.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 SVN](https://www.simantics.org/svn/members/simupedia)
+* Simupedia - [members/simupedia.git](https://www.simantics.org:8088/r/gitweb?p=members/simupedia.git;a=summary)
-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.
+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.
----
<unit id="org.simantics.sdk.source.feature.group" version="x.y.z[.w]"/>
~~~
- Next, replace the following rows in both mentioned files:
+ Next, replace the following rows in both mentioned files:
~~~
<repository location="http://www.simantics.org/download/master/sdk"/>
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).
+
+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.
+
+5. Commit the changes made
+
+ git commit -a
+
+ with the commit message
+
+ Configured release/x.y.z[.w] branch for SDK builds.
+
+ refs #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]
+
+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).
+
+ 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.
+
### Initialize release branch distribution web site
* Run [SDK/Deploy External Components to Web](https://www.simantics.org/jenkins/job/SDK/job/Deploy%20External%20Components%20to%20Web/) build with parameters:
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
+ cd platform
git checkout release/x.y.z[.w]
- git tag vx.y.z[.w] -m "Simantics x.y.z[.w] release"
+ git tag vx.y.z[.w] -m "Simantics x.y.z[.w] simultaneous 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 tag vx.y.z[.w] -m "Simantics x.y.z[.w] simultaneous release"
git push origin --tags
> Note The -m argument must be supplied to create an [annotated tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging).
> Only annotated or signed tags can be pushed to Gerrit.
-## Backup documentation wiki databases
+## Backup documentation wiki databases
This step is only necessary for major/minor releases, not for service releases.
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.
+separate Mediawiki installation.
1. Dump documentation wiki databases using [dump-wikis.sh](./dump-wikis.sh) script.
2. Put the generated backup x.y.z.tar.gz at /var/backup/simantics-releases/x.y.z/wiki/
## Disseminate information about the release
-* [Developer Wiki](http://dev.simantics.org): Update roadmap at http://dev.simantics.org/index.php/Roadmap
-* [Redmine](https://www.simantics.org/redmine/): Post news on the developer/user-visible changes here.
+* [Developer Wiki](http://dev.simantics.org): Update roadmap at [http://dev.simantics.org/index.php/Roadmap](http://dev.simantics.org/index.php/Roadmap)
+* [Redmine](https://www.simantics.org/redmine/): Post news on the developer/user-visible changes here
* [simantics.org](https://www.simantics.org): Post news on the release and a link to the redmine post
* [Members Wiki](https://www.simantics.org/members/): Update frame plan to reflect the realized dates and link to Redmine news
* [mailto:simantics-developers@simantics.org](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.
# 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
-
-* 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
\ No newline at end of file