]> gerrit.simantics Code Review - simantics/platform.git/blobdiff - releng/doc/release.md
Fixed documentation dumping scripts.
[simantics/platform.git] / releng / doc / release.md
index a9a681bf22209730466fab49ca9169b33859629c..23badbcf447fc9d7b7bc96143f60708816d4b038 100644 (file)
@@ -58,26 +58,42 @@ With service releases, branch from an existing `release/*` branch instead.
        git branch release/x.y.z[.w] remotes/origin/release/x.y.z[.w]\r
        git checkout release/x.y.z[.w]\r
 \r
-2. Edit the beginning of the file `releng/org.simantics.sdk.build.targetdefinition/simantics.target`\r
+2. Edit all target platform files in  `releng/org.simantics.sdk.build.targetdefinition/`, i.e.\r
+   * `simantics.target`\r
+   * `org.simantics.sdk.build.targetdefinition.target`\r
+   * `org.simantics.sdk.build.targetdefinition-semantum.target`\r
+\r
+   At the beginning of each .target file, increment `sequenceNumber` by 1\r
    ~~~\r
    <?xml version="1.0" encoding="UTF-8" standalone="no"?>\r
    <?pde version="3.8"?>\r
-   <target name="Simantics 1.25.0" sequenceNumber="10">\r
-   <locations>\r
-   <location includeAllPlatforms="true" includeConfigurePhase="false" includeMode="slicer" includeSource="true" type="InstallableUnit">\r
-   <unit id="org.simantics.sdk.feature.group" version="1.25.0"/>\r
+   <target name="Simantics x.y.z[.w]" sequenceNumber="11">\r
+   ~~~\r
+\r
+   Next, replace the following rows in those files:   \r
+\r
+   ~~~\r
    <repository location="http://www.simantics.org/download/master/sdk"/>\r
-   </location>\r
+   <repository location="http://www.simantics.org/download/master/external-components/maven"/>\r
+   <repository location="http://www.simantics.org/download/master/external-components/manual"/>\r
    ~~~\r
 \r
-   * Change `<repository location=` value to `http://www.simantics.org/download/release/x.y.z[.w]/sdk`\r
-   * Increment `sequenceNumber` by 1\r
+   with\r
+\r
+   ~~~\r
+   <repository location="http://www.simantics.org/download/release/x.y.z[.w]/sdk"/>\r
+   <repository location="http://www.simantics.org/download/release/x.y.z[.w]/external-components/maven"/>\r
+   <repository location="http://www.simantics.org/download/release/x.y.z[.w]/external-components/manual"/>\r
+   ~~~\r
 \r
 ### Initialize release branch distribution web site\r
 \r
-* Run the [SDK/Simantics SDK](https://www.simantics.org/jenkins/job/SDK/job/Simantics SDK) build with parameters:\r
-  * `REFSPEC: refs/heads/release/x.y.z[.w]`\r
-  * `PUBLISHED_BRANCH_NAME: release/x.y.z[.w]`\r
+* Run [SDK/Deploy External Components to Web](https://www.simantics.org/jenkins/job/SDK/job/Deploy%20External%20Components%20to%20Web/) build with parameters:\r
+  * **GERRIT_REFNAME:** `release/x.y.z[.w]`\r
+  * **PUBLISH_ARTIFACTS:** `true`\r
+* Run the [SDK/Simantics SDK](https://www.simantics.org/jenkins/job/SDK/job/Simantics%20SDK/) build with parameters:\r
+  * **GERRIT_REFNAME:** `release/x.y.z[.w]`\r
+  * **PUBLISH_ARTIFACTS:** `true`\r
 \r
 ## Review documentation\r
 \r
@@ -116,14 +132,13 @@ 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).\r
 > Only annotated or signed tags can be pushed to Gerrit.\r
 \r
-## Tag documentation wikis\r
+## Dump documentation wikis\r
 \r
-Tag documentation wiki using [tag.sh](./tag.sh) script.\r
+Dump documentation wiki using [dump-wikis.sh](./dump-wikis.sh) script.\r
 \r
-The wiki documentation is mainly in MediaWiki installations. The only sane way to tag the documentation is to clone it:\r
-* Copy the wiki installation from wiki to ${release_version}/wiki\r
-* Copy the trunk wiki MySQL database into a new version\r
-* Reconfigure the tagged wiki (LocalSettings.php) to use the copied database and no longer allow any edits\r
+The wiki documentation is mainly in MediaWiki installations. The only\r
+sane way to tag the documentation is to back up the mysql database\r
+backing the wiki.\r
 \r
 ## Compile change log entry\r
 \r