From: Ben Soares <b.soares@dundee.ac.uk>
Date: Mon, 13 Jun 2022 15:20:12 +0000 (+0100)
Subject: JAL-4004 Fix missing whatsNew.html when not building with RELEASE channel set
X-Git-Tag: Release_2_11_2_6~50
X-Git-Url: http://source.jalview.org/gitweb/?p=jalview.git;a=commitdiff_plain;h=135c826c69042c04c64cb8df30fdaef92eeb4ffc

JAL-4004 Fix missing whatsNew.html when not building with RELEASE channel set
---

diff --git a/build.gradle b/build.gradle
index 51c7eb2..4f9798c 100644
--- a/build.gradle
+++ b/build.gradle
@@ -48,7 +48,7 @@ plugins {
   id "com.diffplug.gradle.spotless" version "3.28.0"
   id 'com.github.johnrengelman.shadow' version '4.0.3'
   id 'com.install4j.gradle' version '9.0.6'
-  id 'com.dorongold.task-tree' version '1.5' // only needed to display task dependency tree with  gradle task1 [task2 ...] taskTree
+  id 'com.dorongold.task-tree' version '2.1.0' // only needed to display task dependency tree with  gradle task1 [task2 ...] taskTree
   id 'com.palantir.git-version' version '0.13.0' apply false
 }
 
@@ -1407,14 +1407,52 @@ def getMdSections(String content) {
   return sections
 }
 
+
+task copyHelp(type: Copy) {
+  def inputDir = helpSourceDir
+  def outputDir = "${helpBuildDir}/${help_dir}"
+  from(inputDir) {
+    include('**/*.txt')
+    include('**/*.md')
+    include('**/*.html')
+    include('**/*.hs')
+    include('**/*.xml')
+    include('**/*.jhm')
+    filter(ReplaceTokens,
+      beginToken: '$$',
+      endToken: '$$',
+      tokens: [
+        'Version-Rel': JALVIEW_VERSION,
+        'Year-Rel': getDate("yyyy")
+      ]
+    )
+  }
+  from(inputDir) {
+    exclude('**/*.txt')
+    exclude('**/*.md')
+    exclude('**/*.html')
+    exclude('**/*.hs')
+    exclude('**/*.xml')
+    exclude('**/*.jhm')
+  }
+  into outputDir
+
+  inputs.dir(inputDir)
+  outputs.files(helpFile)
+  outputs.dir(outputDir)
+}
+
+
 task releasesTemplates {
   group "help"
   description "Recreate whatsNew.html and releases.html from markdown files and templates in help"
 
+  dependsOn copyHelp
+
   def releasesTemplateFile = file("${jalviewDir}/${releases_template}")
   def whatsnewTemplateFile = file("${jalviewDir}/${whatsnew_template}")
-  def releasesHtmlFile = file("${helpSourceDir}/${releases_html}")
-  def whatsnewHtmlFile = file("${helpSourceDir}/${whatsnew_html}")
+  def releasesHtmlFile = file("${helpBuildDir}/${help_dir}/${releases_html}")
+  def whatsnewHtmlFile = file("${helpBuildDir}/${help_dir}/${whatsnew_html}")
   def releasesMdDir = "${jalviewDir}/${releases_dir}"
   def whatsnewMdDir = "${jalviewDir}/${whatsnew_dir}"
 
@@ -1478,16 +1516,16 @@ task releasesTemplates {
       }
       def displayDate = releaseFilesDates[rFile].format("dd/MM/yyyy")
 
-        def lm = null
-        def rContentProcessed = ""
-        rContent.eachLine { line ->
-          if (lm = line =~ /^(\s*-)(\s*<!--[^>]*?-->)(.*)$/) {
-            line = "${lm[0][1]}${lm[0][3]}${lm[0][2]}"
-        } else if (lm = line =~ /^###([^#]+.*)$/) {
-            line = "_${lm[0][1].trim()}_"
-          }
-          rContentProcessed += line + "\n"
+      def lm = null
+      def rContentProcessed = ""
+      rContent.eachLine { line ->
+        if (lm = line =~ /^(\s*-)(\s*<!--[^>]*?-->)(.*)$/) {
+          line = "${lm[0][1]}${lm[0][3]}${lm[0][2]}"
+      } else if (lm = line =~ /^###([^#]+.*)$/) {
+          line = "_${lm[0][1].trim()}_"
         }
+        rContentProcessed += line + "\n"
+      }
 
       def rContentSections = getMdSections(rContentProcessed)
       def rVersion = versionTemplate
@@ -1526,6 +1564,8 @@ task releasesTemplates {
           DISPLAY_DATE: wnDisplayDate
         ]
       )
+    } else if (gradle.taskGraph.hasTask(":linkCheck")) {
+      whatsnewHtmlFile.text = "Development build " + getDate("yyyy-MM-dd HH:mm:ss")
     }
 
   }
@@ -1539,43 +1579,6 @@ task releasesTemplates {
 }
 
 
-task copyHelp(type: Copy) {
-  dependsOn releasesTemplates
-
-  def inputDir = helpSourceDir
-  def outputDir = "${helpBuildDir}/${help_dir}"
-  from(inputDir) {
-    include('**/*.txt')
-    include('**/*.md')
-    include('**/*.html')
-    include('**/*.hs')
-    include('**/*.xml')
-    include('**/*.jhm')
-    filter(ReplaceTokens,
-      beginToken: '$$',
-      endToken: '$$',
-      tokens: [
-        'Version-Rel': JALVIEW_VERSION,
-        'Year-Rel': getDate("yyyy")
-      ]
-    )
-  }
-  from(inputDir) {
-    exclude('**/*.txt')
-    exclude('**/*.md')
-    exclude('**/*.html')
-    exclude('**/*.hs')
-    exclude('**/*.xml')
-    exclude('**/*.jhm')
-  }
-  into outputDir
-
-  inputs.dir(inputDir)
-  outputs.files(helpFile)
-  outputs.dir(outputDir)
-}
-
-
 task copyResources(type: Copy) {
   group = "build"
   description = "Copy (and make text substitutions in) the resources dir to the build area"
@@ -1673,6 +1676,7 @@ task prepare {
   dependsOn buildResources
   dependsOn copyDocs
   dependsOn copyHelp
+  dependsOn releasesTemplates
   dependsOn convertMdFiles
   dependsOn buildIndices
 }
@@ -1745,7 +1749,7 @@ task linkCheck(type: JavaExec) {
   def helpLinksCheckerOutFile = file("${jalviewDir}/${utils_dir}/HelpLinksChecker.out")
   classpath = files("${jalviewDir}/${utils_dir}")
   main = "HelpLinksChecker"
-  workingDir = jalviewDir
+  workingDir = "${helpBuildDir}"
   args = [ "${helpBuildDir}/${help_dir}", "-nointernet" ]
 
   def outFOS = new FileOutputStream(helpLinksCheckerOutFile, false) // false == don't append