X-Git-Url: https://gerrit.simantics.org/r/gitweb?a=blobdiff_plain;f=releng%2Fdoc%2Frelease.html;h=aaccfc9152e0da5fdae61f9e56275cee47dac70e;hb=befd1d92fb37c9b95ea0b1262385199d9e78380d;hp=126c76cd889489ed514ec46d3e8111b771850cf6;hpb=70d2af523cf495a41ad1ef5a40ec56c7362e59e2;p=simantics%2Fplatform.git diff --git a/releng/doc/release.html b/releng/doc/release.html index 126c76cd8..aaccfc915 100644 --- a/releng/doc/release.html +++ b/releng/doc/release.html @@ -297,8 +297,9 @@ img {
  • 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.
  • Roadmap is up-to-date.
  • Tutorials are up-to-date and coherent with the platform.
    • -
  • For all new major/minor releases, Wiki documentation is backed up (cloned). This is not necessary for service releases of old release branches.
    • +
  • 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.

    +

    Products that are part of the release train:

    - -
  • Update websites to reflect the new release +

    Plug-in components 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.

    +
    +

    Release Schedule

    + -

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

    +

    Simantics Platform Release - Step by Step

    Create release branch from selected commit

    When release stabilisation starts, branch simantics/platform and simantics/third-party repositories:

    @@ -363,14 +374,17 @@ git checkout release/x.y.z[.w] -

    At the beginning of each .target file, increment sequenceNumber by 1

    +

    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 those files:

    +

    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"/>
@@ -381,6 +395,41 @@ git checkout release/x.y.z[.w]
 <repository location="http://www.simantics.org/download/release/x.y.z[.w]/external-components/manual"/>
    +
  • +

    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.

    +
    • +
  • +

    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.

    +
    • +
  • +

    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]
+
    +
    • +
  • +

    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

    +

    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.

    Review documentation

    Documentation to review:

    For each wiki page: