X-Git-Url: https://gerrit.simantics.org/r/gitweb?p=simantics%2Fplatform.git;a=blobdiff_plain;f=releng%2Fdoc%2Frelease.html;h=ccb50611d4d4e536617091735e75fda901f1813b;hp=126c76cd889489ed514ec46d3e8111b771850cf6;hb=a70b679206efa41e6ebe3c32e156e8b55ca0b9aa;hpb=70d2af523cf495a41ad1ef5a40ec56c7362e59e2 diff --git a/releng/doc/release.html b/releng/doc/release.html index 126c76cd8..ccb50611d 100644 --- a/releng/doc/release.html +++ b/releng/doc/release.html @@ -293,12 +293,13 @@ img {

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].
    2. +
  2. 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].
  3. A change log entry 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.
  4. Roadmap is up-to-date.
  5. Tutorials are up-to-date and coherent with the platform.
    6. -
  6. For all new major/minor releases, Wiki documentation is backed up (cloned). This is not necessary for service releases of old release branches.
    7. +
  7. For all new major/minor releases, Wiki documentation is backed up (cloned).
+

Simantics Platform Release Process

  • Tag the release in repository
    • -
  • Tag documentation +
  • Backup documentation wiki databases
    • +
  • Build and publish SDK package with and without sources
    • -
  • Build and publish SDK package with and without sources
    • -
  • Build Simantics open source products and plug-in components which are a part of the release train +
  • Build Simantics open source products and plug-in components which are a part of the release train
    • +
  • Update websites to reflect the new release
    • + +
    +

    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.

    +

    Core components of the release train:

    - -
  • Update websites to reflect the new release +

    Plug-in components that are part of the release train:

    + +

    Products that are part of the release train:

    -

    In the following sections each task is described step by step.

    +

    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.

    +
    +

    Release Schedule

    + +

    Simantics Platform Release - Step by Step

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

      @@ -359,27 +394,65 @@ 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.

        -
      • simantics.target
        • -
      • org.simantics.sdk.build.targetdefinition.target
        • -
      • org.simantics.sdk.build.targetdefinition-semantum.target
        • +
      • org.simantics.sdk.build.targetdefinition.tpd
        • +
      • simantics.tpd
      -

      At the beginning of each .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 those 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" {
+
      
+
      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 or review 1361.

      +
      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 or in review 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.

    Initialize release branch distribution web site

    @@ -397,12 +470,30 @@ 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 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 for an example.

    +

    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:

    For each wiki page: