X-Git-Url: https://gerrit.simantics.org/r/gitweb?a=blobdiff_plain;f=releng%2Fdoc%2Frelease.md;h=871b1d0aa3eb0b56069ee1be66033d91bdec3b03;hb=befd1d92fb37c9b95ea0b1262385199d9e78380d;hp=b16736e80aeed1e5cef81c33852eed98d0a115ac;hpb=5170c2970a46bb3d1d0d3e68fc88269fbe1647b0;p=simantics%2Fplatform.git diff --git a/releng/doc/release.md b/releng/doc/release.md index b16736e80..871b1d0aa 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) @@ -36,9 +36,9 @@ 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) +* Simupedia - [members/simupedia.git](https://www.simantics.org:8088/r/gitweb?p=members/simupedia.git;a=summary) -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/ @@ -246,8 +246,8 @@ separate Mediawiki installation. ## 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. +* [Developer Wiki](http://dev.simantics.org): Update roadmap at [http://dev.simantics.org/index.php/Roadmap](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 * [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: @@ -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. @@ -278,11 +278,11 @@ Insert some general thoughts on the release... # TODO +* Start using [https://github.com/mbarbero/fr.obeo.releng.targetplatform](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. - +* 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 \ No newline at end of file