X-Git-Url: https://gerrit.simantics.org/r/gitweb?p=simantics%2Fplatform.git;a=blobdiff_plain;f=releng%2Fdoc%2Frelease.html;h=ebe85ee67cb86e68d53ae6eba18c0f471923dd1f;hp=95689d660777356f29bd1104d1a32c641ece43fe;hb=4bb82aede02d798846196cc4f51e09d9f9161fef;hpb=ada4db363b15212dbfa34953b03b2d9dbaafa8c6 diff --git a/releng/doc/release.html b/releng/doc/release.html index 95689d660..ebe85ee67 100644 --- a/releng/doc/release.html +++ b/releng/doc/release.html @@ -320,19 +320,28 @@ img {

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:

-

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.

@@ -359,7 +368,9 @@ 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.

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) 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

    @@ -370,26 +381,59 @@ git checkout release/x.y.z[.w]
  2. -

    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.

    -

    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/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" {
+
    
+
    3. +
  3. +

    Edit version number of org.simantics.sdk feature in features/org.simantics.sdk.feature/feature.xml to x.y.z[.w].

    +
    <feature
+      id="org.simantics.sdk"
+      label="Simantics SDK"
+      version="x.y.z"
+      provider-name="VTT Technical Research Centre of Finland">
+
    +

    An example of these changes can be seen in gitweb.

    +
    4. +
  4. +

    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.

    +
    5. +
  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. +
  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.

    +

    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

@@ -410,6 +454,20 @@ git checkout release/x.y.z[.w]

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

+ +

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: