From d69a600dd9859af971007536319276ccfc682168 Mon Sep 17 00:00:00 2001 From: Tuukka Lehtonen Date: Wed, 7 Jun 2017 08:49:43 +0300 Subject: [PATCH] Minor wording update to release engineering instructions. refs #7263 Change-Id: I8cc31482fb4db482aa76e4798623f62e4948655f --- releng/doc/release.html | 1206 +++++++++++++++++++-------------------- releng/doc/release.md | 26 +- 2 files changed, 616 insertions(+), 616 deletions(-) diff --git a/releng/doc/release.html b/releng/doc/release.html index df0f9d70f..17c7d28f4 100644 --- a/releng/doc/release.html +++ b/releng/doc/release.html @@ -1,603 +1,603 @@ - - - -release - - - - -

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. 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.
    3. -
  3. Roadmap is up-to-date.
    4. -
  4. Tutorials are up-to-date and coherent with the platform.
    5. -
  5. For all new major/minor releases, Wiki documentation is backed up (cloned).
    6. -
-
-

Simantics Platform Release Process

- -
-

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:

- -

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

- -
-

Simantics Platform Release - Step by Step

-

Create release branch from selected commit

-

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

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

-

Prepare release branch for use

-

Prepare .target files

-
    -
  1. -

    Retrieve release branch of the platform repository

    -
    git clone ssh://<user>@www.simantics.org:29418/simantics/platform.git
-cd platform
-git branch release/x.y.z[.w] remotes/origin/release/x.y.z[.w]
-git checkout release/x.y.z[.w]
-
    -
    2. -
  2. -

    Edit all target platform files in releng/org.simantics.sdk.build.targetdefinition/, i.e.

    -
      -
    • simantics.target
      • -
    • org.simantics.sdk.build.targetdefinition.target
      • -
    -

    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 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"/>
-
    -

    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"/>
-
    -
    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.

    -
    7. -
-

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:

- -

Review tutorials

- -

Tag release/* branches

-

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    
-git checkout release/x.y.z[.w]
-git tag vx.y.z[.w] -m "Simantics x.y.z[.w] 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 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.

-
-

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.

-
    -
  1. Dump documentation wiki databases using dump-wikis.sh script.
    2. -
  2. Put the generated backup x.y.z.tar.gz at /var/backup/simantics-releases/x.y.z/wiki/
    3. -
-

Compile change log entry

- -

Disseminate information about the release

- -

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.
-
-Best regards,
-Simantics Release Engineering Team
-
-

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

- - - - - - + + + +release + + + + +

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. 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.
    3. +
  3. Roadmap is up-to-date.
    4. +
  4. Tutorials are up-to-date and coherent with the platform.
    5. +
  5. For all new major/minor releases, Wiki documentation is backed up (cloned).
    6. +
+
+

Simantics Platform Release Process

+ +
+

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:

+ +

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

+ +
+

Simantics Platform Release - Step by Step

+

Create release branch from selected commit

+

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

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

+

Prepare release branch for use

+

Prepare .target files

+
    +
  1. +

    Retrieve release branch of the platform repository

    +
    git clone ssh://<user>@www.simantics.org:29418/simantics/platform.git
+cd platform
+git branch release/x.y.z[.w] remotes/origin/release/x.y.z[.w]
+git checkout release/x.y.z[.w]
+
    +
    2. +
  2. +

    Edit all target platform files in releng/org.simantics.sdk.build.targetdefinition/, i.e.

    +
      +
    • simantics.target
      • +
    • org.simantics.sdk.build.targetdefinition.target
      • +
    +

    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 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"/>
+
    +

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

    +
    7. +
+

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:

+ +

Review tutorials

+ +

Tag release/* branches

+

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    
+git checkout release/x.y.z[.w]
+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] simultaneous release"
+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.

+
+

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.

+
    +
  1. Dump documentation wiki databases using dump-wikis.sh script.
    2. +
  2. Put the generated backup x.y.z.tar.gz at /var/backup/simantics-releases/x.y.z/wiki/
    3. +
+

Compile change log entry

+ +

Disseminate information about the release

+ +

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.
+
+Best regards,
+Simantics Release Engineering Team
+
+

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

+ + + + + + diff --git a/releng/doc/release.md b/releng/doc/release.md index b16736e80..79359efd2 100644 --- a/releng/doc/release.md +++ b/releng/doc/release.md @@ -22,13 +22,13 @@ ---- -# 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) @@ -38,7 +38,7 @@ Plug-in components that are part of the release train: * 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. +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. ---- @@ -95,7 +95,7 @@ With service releases, branch from an existing `release/*` branch instead. ~~~ - Next, replace the following rows in both mentioned files: + Next, replace the following rows in both mentioned files: ~~~ @@ -134,7 +134,7 @@ With service releases, branch from an existing `release/*` branch instead. refs #xxxx - where `#xxxx` is the number of the x.y.z[.w] release engineering issue and push them to remote + 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] @@ -186,21 +186,21 @@ For each wiki page: When the release branches are ready for the release, tag them with the tag `vx.y.z[.w]`: git clone ssh://@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://@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. @@ -211,7 +211,7 @@ 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. +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/ @@ -255,7 +255,7 @@ separate Mediawiki installation. **Newsletter template:** ~~~ Hello everyone, - + Simantics release x.y.z[.w] has been released. Head over to https://www.simantics.org/redmine/news/ for the release news. @@ -283,6 +283,6 @@ Insert some general thoughts on the release... * 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. -- 2.47.1