From 9811f78d989b67c48f74a9f8ad6dbf273f24d2bb Mon Sep 17 00:00:00 2001 From: Tuukka Lehtonen Date: Mon, 19 Dec 2016 16:05:01 +0200 Subject: [PATCH] Added release schedule and produced artifact documentation Also removed the -semantum.target file since it is not really useful anymore. refs #6881 --- releng/doc/release.html | 105 ++++++--- releng/doc/release.md | 100 +++++--- ...sdk.build.targetdefinition-semantum.target | 221 ------------------ 3 files changed, 140 insertions(+), 286 deletions(-) delete mode 100644 releng/org.simantics.sdk.build.targetdefinition/org.simantics.sdk.build.targetdefinition-semantum.target diff --git a/releng/doc/release.html b/releng/doc/release.html index 126c76cd8..95689d660 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,13 @@ 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

    <?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:

    +

    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"/>
@@ -397,12 +407,15 @@ 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.
    
 
    Review documentation
    
 
    Documentation to review:
    
 
 
    For each wiki page:
    
 
      
@@ -441,11 +454,18 @@ git push origin --tags
 
      Note The -m argument must be supplied to create an annotated tag.
 Only annotated or signed tags can be pushed to Gerrit.
      
 
-
      Dump documentation wikis
      
-
      Dump documentation wiki using dump-wikis.sh script.
      
-
      The wiki documentation is mainly in MediaWiki installations. The only
-sane way to tag the documentation is to back up the mysql database
-backing the wiki.
      
+
      Backup documentation wiki databases
      
+
      This step is only necessary for major/minor releases, not for service releases.
      
+
      The wiki databases to be backed up are:
      
+
+
      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.
      
+
      Dump documentation wiki databases using dump-wikis.sh script.
      
 
      Compile change log entry
      
 
        
 
      • Edit the main page and add a a link for release x.y.z[.w].
        • 
@@ -494,12 +514,13 @@ backing the wiki.
        
 
      
 
      Disseminate information about the release
      
 
-
      Mail template:
      
+
      Newsletter template:
      
 
      Hello everyone,
    
 Simantics release x.y.z[.w] has been released. Head over to
@@ -509,18 +530,30 @@ for the release news.
 Best regards,
 Simantics Release Engineering Team
 
      
-
      News entry template:
      
-
      On <date> Simantics x.y.z[.w] was tagged in SVN. Please find change log at:
-* [[simantics-platform:Simantics_xyzw|Simantics x.y.z.w]]
+
      Redmine news template:
      
+
      Title: Simantics x.y.z[.w] released
+
+Simantics x.y.z[.w] was released on <date>.
+Please find change log at: [[simantics-platform:Simantics_xyzw|Simantics x.y.z[.w]]]
 
 Insert some general thoughts on the release...
 
      
 
      
 
      TODO
      
 
        
-
      • 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
        • 
-
      • Create a parametrized release train pipeline build in Jenkins that creates all artifacts of a simantics release in one go
        • 
-
      • Start using 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.
        
+
        • 
 
      
 
 
diff --git a/releng/doc/release.md b/releng/doc/release.md
index 23badbcf4..4fdad593e 100644
--- a/releng/doc/release.md
+++ b/releng/doc/release.md
@@ -4,7 +4,9 @@
 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.
-5. For all new major/minor releases, Wiki documentation is backed up (cloned). This is not necessary for service releases of old release branches.
+5. For all new major/minor releases, Wiki documentation is backed up (cloned).
+
+----
 
 # Simantics Platform Release Process
 
@@ -12,21 +14,41 @@
 * Repeat until stable:
   * Develop, test and document components and test products
 * Tag the release in repository
-* Tag documentation
-  * [https://www.simantics.org/wiki](https://www.simantics.org/wiki) ⇒ [http://www.simantics.org/<version>/wiki](http://www.simantics.org//wiki)
+* Backup documentation wiki databases
 * Build and publish SDK package with and without sources
+  * Does not really require any work
 * Build Simantics open source products and plug-in components which are a part of the release train
-  * Simantics Sysdyn
-  * Simantics R
-  * Simupedia
-  * FMI Studio
 * Update websites to reflect the new release
-  * [dev.simantics.org](http://dev.simantics.org)
-  * [www.simantics.org/end_user_wiki/](https://www.simantics.org/end_user_wiki/)
-  * [www.simantics.org/members/](https://www.simantics.org/members/)
-  * [www.simantics.org](https://www.simantics.org)
 
-In the following sections each task is described step by step.
+----
+
+# 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: 
+* Simantics Desktop
+* Simantics System Dynamics Tool - [simantics/sysdyn.git](https://www.simantics.org:8088/r/gitweb?p=simantics/sysdyn.git;a=summary)
+
+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)
+* 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)
+
+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
+
+* Releases are branched 4 weeks before the set release date.
+* During this time no more new features are allowed in the release branch and the existing work shall be stabilized. Work must be focused on bug fixes and documentation.
+* Source code changes to release branches are forbidden in the last 2 weeks. Documentation-only changes are still allowed. However, if critical show-stopper problems surface during that time, the changes must be done. After that the release engineering team must decide whether to stick to the original release schedule or whether to delay the release.   
+
+----
 
 # Simantics Platform Release - Step by Step
 
@@ -61,16 +83,15 @@ With service releases, branch from an existing `release/*` branch instead.
 2. 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`
 
-   At the beginning of each .target file, increment `sequenceNumber` by 1
+   At the beginning of simantics.target file, increment `sequenceNumber` by 1
    ~~~
    
    
    
    ~~~
 
-   Next, replace the following rows in those files:   
+   Next, replace the following rows in both mentioned files:   
 
    ~~~
    
@@ -95,12 +116,18 @@ With service releases, branch from an existing `release/*` branch instead.
   * **GERRIT_REFNAME:** `release/x.y.z[.w]`
   * **PUBLISH_ARTIFACTS:** `true`
 
+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](https://www.simantics.org/jenkins/job/SDK/job/Simantics%20SDK/) Jenkins job.
+
 ## Review documentation
 
 Documentation to review:
 * [Developer wiki](http://dev.simantics.org/)
-* [End-user wiki](http://www.simantics.org/end_user_wiki)
-* [Member wiki](http://www.simantics.org/members)
+* [End-user wiki](https://www.simantics.org/end_user_wiki)
+* [Member wiki](https://www.simantics.org/members)
 
 For each wiki page:
 * Read through and get authors to fix found problems, such as TODOs or invalid information.
@@ -132,13 +159,20 @@ When the release branches are ready for the release, tag them with the tag `vx.y
 > 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.
 
-## Dump documentation wikis
+## Backup documentation wiki databases 
+
+This step is only necessary for major/minor releases, not for service releases.
 
-Dump documentation wiki using [dump-wikis.sh](./dump-wikis.sh) script.
+The wiki databases to be backed up are:
+* [Developer wiki](http://dev.simantics.org/)
+* [End-user wiki](https://www.simantics.org/end_user_wiki)
+
+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. 
 
-The wiki documentation is mainly in MediaWiki installations. The only
-sane way to tag the documentation is to back up the mysql database
-backing the wiki.
+Dump documentation wiki databases using [dump-wikis.sh](./dump-wikis.sh) script.
 
 ## Compile change log entry
 
@@ -170,12 +204,13 @@ backing the 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.
 * [simantics.org](https://www.simantics.org): Post news on the release and a link to the redmine post
-* [dev wiki](http://dev.simantics.org): Update roadmap at http://dev.simantics.org/index.php/Roadmap
-* [simantics-developers@simantics.org](mailto:simantics-developers@simantics.org) Send mail to simantics-developers:
+* [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:
 
-**Mail template:**
+**Newsletter template:**
 ~~~
 Hello everyone,
    
@@ -187,10 +222,12 @@ Best regards,
 Simantics Release Engineering Team
 ~~~
 
-**News entry template:**
+**Redmine news template:**
 ~~~
-On  Simantics x.y.z[.w] was tagged in SVN. Please find change log at:
-* [[simantics-platform:Simantics_xyzw|Simantics x.y.z.w]]
+Title: Simantics x.y.z[.w] released
+
+Simantics x.y.z[.w] was released on .
+Please find change log at: [[simantics-platform:Simantics_xyzw|Simantics x.y.z[.w]]]
 
 Insert some general thoughts on the release...
 ~~~
@@ -199,6 +236,11 @@ Insert some general thoughts on the release...
 
 # TODO
 
+* 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
-* Create a parametrized release train pipeline build in Jenkins that creates all artifacts of a simantics release in one go
+ 
 * Start using https://github.com/mbarbero/fr.obeo.releng.targetplatform to generate `.target` files. `.tpd` files allow specifying version ranges instead of specific versions.
+
diff --git a/releng/org.simantics.sdk.build.targetdefinition/org.simantics.sdk.build.targetdefinition-semantum.target b/releng/org.simantics.sdk.build.targetdefinition/org.simantics.sdk.build.targetdefinition-semantum.target
deleted file mode 100644
index e42b58148..000000000
--- a/releng/org.simantics.sdk.build.targetdefinition/org.simantics.sdk.build.targetdefinition-semantum.target
+++ /dev/null
@@ -1,221 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-- 
2.47.1