From 7e58fdb919624619476a3c4389418889f1120209 Mon Sep 17 00:00:00 2001 From: Ben Soares Date: Wed, 27 Apr 2022 23:39:34 +0100 Subject: [PATCH] JAL-3989 Populate template files for hugo build: archive version files including changes from releases.html, and installers data file --- build.gradle | 200 ++++++++++++++++++-- gradle.properties | 4 + .../Version-__VERSION_UNDERSCORES__/_index.md | 15 ++ .../Version-__VERSION_UNDERSCORES__/installers.md | 11 ++ 4 files changed, 216 insertions(+), 14 deletions(-) create mode 100644 utils/hugo/templates/content/development/archive/Version-__VERSION_UNDERSCORES__/_index.md create mode 100644 utils/hugo/templates/content/development/archive/Version-__VERSION_UNDERSCORES__/installers.md diff --git a/build.gradle b/build.gradle index 3573ac7..b0d0fbb 100644 --- a/build.gradle +++ b/build.gradle @@ -26,6 +26,7 @@ import com.vladsch.flexmark.ext.toc.TocExtension import com.google.common.hash.HashCode import com.google.common.hash.Hashing import com.google.common.io.Files +import org.jsoup.Jsoup buildscript { repositories { @@ -34,6 +35,7 @@ buildscript { } dependencies { classpath "com.vladsch.flexmark:flexmark-all:0.62.0" + classpath "org.jsoup:jsoup:1.14.3" } } @@ -226,6 +228,8 @@ ext { install4jBackground = string("${install4j_images_dir}/${install4j_background}") install4jBuildDir = "${install4j_build_dir}/${JAVA_VERSION}" install4jCheckSums = true + + applicationName = "${jalview_name}" switch (CHANNEL) { case "BUILD": @@ -344,7 +348,8 @@ ext { } JALVIEW_VERSION_UNDERSCORES = JALVIEW_VERSION.replaceAll("\\.", "_") - hugoDataJsonFile = file("${jalviewDir}/${hugo_build_dir}/data/installers/installers-${JALVIEW_VERSION_UNDERSCORES}.json") + hugoDataJsonFile = file("${jalviewDir}/${hugo_build_dir}/${hugo_data_installers_dir}/installers-${JALVIEW_VERSION_UNDERSCORES}.json") + hugoArchiveMdFile = file("${jalviewDir}/${hugo_build_dir}/${hugo_version_archive_dir}/Version-${JALVIEW_VERSION_UNDERSCORES}/_index.md") // override getdownAppBase if requested if (findProperty("getdown_appbase_override") != null) { // revert to LOCAL if empty string @@ -363,11 +368,10 @@ ext { jvlChannelName = jvlChannelName.replaceAll("[^\\w\\-]+", "_") // install4j application and folder names if (install4jSuffix == "") { - install4jApplicationName = "${jalview_name}" install4jBundleId = "${install4j_bundle_id}" install4jWinApplicationId = install4j_release_win_application_id } else { - install4jApplicationName = "${jalview_name} ${install4jSuffix}" + applicationName = "${jalview_name} ${install4jSuffix}" install4jBundleId = "${install4j_bundle_id}-" + install4jSuffix.toLowerCase() // add int hash of install4jSuffix to the last part of the application_id def id = install4j_release_win_application_id @@ -377,15 +381,15 @@ ext { } // sanitise folder and id names // install4jApplicationFolder = e.g. "Jalview Build" - install4jApplicationFolder = install4jApplicationName + install4jApplicationFolder = applicationName .replaceAll("[\"'~:/\\\\\\s]", "_") // replace all awkward filename chars " ' ~ : / \ .replaceAll("_+", "_") // collapse __ - install4jInternalId = install4jApplicationName + install4jInternalId = applicationName .replaceAll(" ","_") .replaceAll("[^\\w\\-\\.]", "_") // replace other non [alphanumeric,_,-,.] .replaceAll("_+", "") // collapse __ //.replaceAll("_*-_*", "-") // collapse _-_ - install4jUnixApplicationFolder = install4jApplicationName + install4jUnixApplicationFolder = applicationName .replaceAll(" ","_") .replaceAll("[^\\w\\-\\.]", "_") // replace other non [alphanumeric,_,-,.] .replaceAll("_+", "_") // collapse __ @@ -1434,7 +1438,7 @@ jar { manifest { attributes "Main-Class": main_class, "Permissions": "all-permissions", - "Application-Name": install4jApplicationName, + "Application-Name": applicationName, "Codebase": application_codebase, "Implementation-Version": JALVIEW_VERSION } @@ -1507,7 +1511,7 @@ shadowJar { } manifest { attributes "Implementation-Version": JALVIEW_VERSION, - "Application-Name": install4jApplicationName + "Application-Name": applicationName } duplicatesStrategy "INCLUDE" @@ -1569,7 +1573,7 @@ task getdownWebsite() { } props.put("getdown_txt_title", jalview_name) - props.put("getdown_txt_ui.name", install4jApplicationName) + props.put("getdown_txt_ui.name", applicationName) // start with appbase getdownTextLines += "appbase = ${getdownAppBase}" @@ -2044,7 +2048,7 @@ task installerFiles(type: com.install4j.gradle.Install4jTask) { variables = [ 'JALVIEW_NAME': jalview_name, - 'JALVIEW_APPLICATION_NAME': install4jApplicationName, + 'JALVIEW_APPLICATION_NAME': applicationName, 'JALVIEW_DIR': "../..", 'OSX_KEYSTORE': OSX_KEYSTORE, 'OSX_APPLEID': OSX_APPLEID, @@ -2352,6 +2356,11 @@ task dataInstallersJson { group "website" description "Create the installers-VERSION.json data file for installer files created" + mustRunAfter installers + mustRunAfter shadowJar + mustRunAfter sourceDist + mustRunAfter getdownArchive + def installersOutputTxt = file("${jalviewDir}/${install4jBuildDir}/output.txt") def installersSha256 = file("${jalviewDir}/${install4jBuildDir}/sha256sums") @@ -2378,10 +2387,173 @@ task dataInstallersJson { } } -dataInstallersJson.mustRunAfter installers -dataInstallersJson.mustRunAfter shadowJar -dataInstallersJson.mustRunAfter sourceDist -dataInstallersJson.mustRunAfter getdownArchive +def hugoTemplateSubstitutions(String input) { + def output = input + output = output.replaceAll("__DATE__", getDate("yyyy-MM-dd")) + output = output.replaceAll("__CHANNEL__", propertiesChannelName) + output = output.replaceAll("__APPLICATION_NAME__", applicationName) + output = output.replaceAll("__GIT_HASH__", gitHash) + output = output.replaceAll("__GIT_BRANCH__", gitBranch) + output = output.replaceAll("__VERSION__", JALVIEW_VERSION) + output = output.replaceAll("__JAVA_VERSION__", JAVA_VERSION) + output = output.replaceAll("__VERSION_UNDERSCORES__", JALVIEW_VERSION_UNDERSCORES) + return output +} + +task hugoTemplates { + group "website" + description "Create partially populated md pages for hugo website build" + + def hugoTemplatesDir = file("${jalviewDir}/${hugo_templates_dir}") + def hugoBuildDir = "${jalviewDir}/${hugo_build_dir}" + def templateFiles = fileTree(dir: hugoTemplatesDir) + + doFirst { + // specific release template for version archive + def summary = "${applicationName} ${JALVIEW_VERSION}" + def changes = "" + def oldDate = null + if (CHANNEL == "RELEASE") { + def releasesHtmlFile = file("${helpSourceDir}/${releases_html}") + //HTMLPARSE + def html = releasesHtmlFile.text + def doc = Jsoup.parse(html) + def table = doc.select("table").first() + def headings = table.select("tr").first().select("th").collect { it.text() } + def releaseRow = null + def trs = table.select("tr") + trs.any { tr -> + def tds = tr.select("td") + if (tds.size() == 0) + return false + def releaseTd = tds.first() + if (releaseTd.text().startsWith("${JALVIEW_VERSION} ")) { + releaseRow = tr + return true + } + } + + if (releaseRow != null && headings != null && headings.size() == 3) { + def releaseTd = releaseRow.select("td").first() + def spaceIndex = releaseTd.text().indexOf(" ") + if (spaceIndex >= 0) { + oldDate = new Date().parse("dd/MM/yyyy", releaseTd.text().substring(spaceIndex+1)) + } + def releaseCells = releaseRow.select("td") + if (releaseCells.size() == 3) { + def title1 = headings[1] + def title2 = headings[2] + + def lastDotIndex = JALVIEW_VERSION.lastIndexOf(".") + if (lastDotIndex > 0) { + def patchRelease = JALVIEW_VERSION.substring(lastDotIndex+1) as Integer + def patchReleaseString = null + if (patchRelease == 0) { + patchReleaseString = "first minor" + } else if (patchRelease == 1) { + patchReleaseString = "first patch" + } else if (patchRelease == 2) { + patchReleaseString = "second patch" + } else if (patchRelease == 3) { + patchReleaseString = "third patch" + } else if (patchRelease == 4) { + patchReleaseString = "fourth patch" + } else if (patchRelease == 5) { + patchReleaseString = "fifth patch" + } else if (patchRelease == 6) { + patchReleaseString = "sixth patch" + } else if (patchRelease == 7) { + patchReleaseString = "seventh patch" + } else if (patchRelease > 13 && (patchRelease % 10 == 1)) { + patchReleaseString += "st" + } else if (patchRelease > 13 && (patchRelease % 10 == 2)) { + patchReleaseString += "nd" + } else if (patchRelease > 13 && (patchRelease % 10 == 3)) { + patchReleaseString += "rd" + } else if (patchRelease != null) { + patchReleaseString += "th" + } + summary += (patchReleaseString != null) ? " is the ${patchReleaseString} release in the ${JALVIEW_VERSION.substring(0,lastDotIndex)} series." : "" + } + + if (headings[1] != null && headings[1].size() > 0) { + def noheadings = true + releaseCells[1].children().each { e -> + if (e.tagName().toLowerCase() == "ul") { + e.select("li").each { li -> + def mdItem = "- " + li.childNodes().any {n -> + if (n.nodeName().equals("#comment")) { + mdItem += "${n} " + return true + } + } + mdItem += li.text() + if (noheadings) { + changes += "\n### ${headings[1]}\n\n" + noheadings = false + } + changes += "${mdItem}\n" + } + } else if (e.tag() == "em") { + changes += "\n#### ${e.text()}\n\n" + noheadings = false + } + } + } + + if (headings[2] != null && headings[2].size() > 0) { + changes += "\n### ${headings[2]}\n\n" + releaseCells[2].children().each { e -> + if (e.tagName().toLowerCase() == "ul") { + e.select("li").each { li -> + def mdItem = "- " + li.childNodes().any {n -> + if (n.nodeName().equals("#comment")) { + mdItem += "${n} " + return true + } + } + mdItem += li.text() + changes += "${mdItem}\n" + } + } else if (e.tagName().toLowerCase() == "em") { + changes += "\n#### ${e.text()}\n\n" + } + } + } + } + } + } + + templateFiles.each{ templateFile -> + def newFileName = string(hugoTemplateSubstitutions(templateFile.getName())) + def relPath = hugoTemplatesDir.toPath().relativize(templateFile.toPath()).getParent() + def newRelPathName = hugoTemplateSubstitutions( relPath.toString() ) + + def outPathName = string("${hugoBuildDir}/$newRelPathName") + + copy { + from templateFile + rename(templateFile.getName(), newFileName) + into outPathName + } + + def newFile = file("${outPathName}/${newFileName}".toString()) + def content = newFile.text + content = content.replaceAll("__SUMMARY__", summary) + content = content.replaceAll("__CHANGES__", changes) + if (oldDate != null) { + content = content.replaceAll("__DATE__", oldDate.format("yyyy-MM-dd")) + } + newFile.text = hugoTemplateSubstitutions(content) + } + } + + inputs.dir(hugoTemplatesDir) + inputs.property("JALVIEW_VERSION", { JALVIEW_VERSION }) + inputs.property("CHANNEL", { CHANNEL }) +} task helppages { diff --git a/gradle.properties b/gradle.properties index 92a64cc..983eb4a 100644 --- a/gradle.properties +++ b/gradle.properties @@ -59,6 +59,10 @@ shadow_jar_main_class = jalview.bin.Launcher jalview_name = Jalview hugo_build_dir = build/website/hugo +hugo_data_installers_dir = data/installers +hugo_version_archive_dir = content/development/archive +hugo_templates_dir = utils/hugo/templates +releases_html = html/releases.html # these are going to be used in the future to gather website release files together getdown_website_dir = build/website/docroot/getdown getdown_archive_dir = build/website/docroot/old diff --git a/utils/hugo/templates/content/development/archive/Version-__VERSION_UNDERSCORES__/_index.md b/utils/hugo/templates/content/development/archive/Version-__VERSION_UNDERSCORES__/_index.md new file mode 100644 index 0000000..aca6877 --- /dev/null +++ b/utils/hugo/templates/content/development/archive/Version-__VERSION_UNDERSCORES__/_index.md @@ -0,0 +1,15 @@ +--- +type: "__CHANNEL__" +layout: "single-release" +date: __DATE__ +publishdate: __DATE__ +title: __APPLICATION_NAME__ __VERSION__ +cascade: + release_date: __DATE__ + version: "__VERSION__" + jalviewjslink: false +--- + +__SUMMARY__ + +__CHANGES__ diff --git a/utils/hugo/templates/content/development/archive/Version-__VERSION_UNDERSCORES__/installers.md b/utils/hugo/templates/content/development/archive/Version-__VERSION_UNDERSCORES__/installers.md new file mode 100644 index 0000000..5c3118f --- /dev/null +++ b/utils/hugo/templates/content/development/archive/Version-__VERSION_UNDERSCORES__/installers.md @@ -0,0 +1,11 @@ +--- +layout: "single-release" +date: __DATE__ +publishdate: __DATE__ +title: Jalview __VERSION__ Installers +draft: false +--- + +{{< download-table showheader=true displaydate=false >}} + +{{% os-detect-hide %}} -- 1.7.10.2