X-Git-Url: https://gerrit.simantics.org/r/gitweb?p=simantics%2Fplatform.git;a=blobdiff_plain;f=releng%2Fdoc%2Frelease.html;fp=releng%2Fdoc%2Frelease.html;h=95689d660777356f29bd1104d1a32c641ece43fe;hp=126c76cd889489ed514ec46d3e8111b771850cf6;hb=9811f78d989b67c48f74a9f8ad6dbf273f24d2bb;hpb=c3dbc3ffd02ee897f2abb48241cbcf4c5cc50548 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 {
release/x.y.z[.w]
release stabilisation branchThere 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.
+In the following sections each task is described step by step.
+When release stabilisation starts, branch simantics/platform
and simantics/third-party
repositories:
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
<?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
+- Developer Wiki: Update roadmap at http://dev.simantics.org/index.php/Roadmap
- Redmine: Post news on the developer/user-visible changes here.
- simantics.org: Post news on the release and a link to the redmine post
-- dev wiki: Update roadmap at http://dev.simantics.org/index.php/Roadmap
-- simantics-developers@simantics.org Send mail to simantics-developers:
+- Members Wiki: Update frame plan to reflect the realized dates and link to Redmine news
+- mailto:simantics-developers@simantics.org Send "newsletter" to `simantics-developers@simantics.org:
-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.
+