X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=build.gradle;h=d89f3edaaf21f77ce7f675a4393e85457cd3ca34;hb=ce916cd46bbe1ec0446d8672b7341f5af7471b6e;hp=3573ac7da3c863ce4800a2d787a33306dd07bf14;hpb=c67b28d36c11c8d5a7a25921c57f9c30f1855589;p=jalview.git diff --git a/build.gradle b/build.gradle index 3573ac7..d89f3ed 100644 --- a/build.gradle +++ b/build.gradle @@ -26,6 +26,8 @@ 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 +import org.jsoup.nodes.Element buildscript { repositories { @@ -34,6 +36,7 @@ buildscript { } dependencies { classpath "com.vladsch.flexmark:flexmark-all:0.62.0" + classpath "org.jsoup:jsoup:1.14.3" } } @@ -226,6 +229,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 +349,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 +369,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 +382,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 +1439,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 +1512,7 @@ shadowJar { } manifest { attributes "Implementation-Version": JALVIEW_VERSION, - "Application-Name": install4jApplicationName + "Application-Name": applicationName } duplicatesStrategy "INCLUDE" @@ -1569,7 +1574,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 +2049,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 +2357,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 +2388,238 @@ 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 +} + +def ulToList(Element ul, int indent) { + def list = "" + ul.children().each { e -> + if (e.tagName().toLowerCase() == "ul") { + list = list.stripTrailing() + "\n" + list += ulToList(e, indent+1) + } else if (e.tagName().toLowerCase() == "li") { + def issues = [] + def issuesText = "" + def mdItem = " " * indent + "- " + e.childNodes().any {n -> + if (n.nodeName().equals("#comment")) { + mdItem += "{{}}${n.getData()}{{}} " + issuesText = n.getData().trim() + issues = n.getData().trim().split(/[,\s]+/).findAll { it.startsWith("JAL-") } + return true + } + } + def safeText = issuesText.replaceAll('"', '\"') + def joinedIssues = issues.join(",") + def issuesLink = (issues.size() > 0) ? + " {{< jal issue=\"${joinedIssues}\" alt=\"${safeText}\" >}}" + : "" + def addedIssues = false + e.childNodes().each { node -> + if (node.nodeName().toLowerCase() == "ul") { + // add issues link before sub list if it's last + if (node.nextSibling() == null) { + mdItem += "${issuesLink}" + addedIssues = true + } + mdItem = mdItem.stripTrailing() + "\n" + mdItem += ulToList(node, indent+1) + } else if (node.nodeName() == "#text") { + mdItem += node.text() + } else if (node.nodeName().toLowerCase() == "strong") { + mdItem += "**${node.text()}**" + } else if (node.nodeName().toLowerCase() == "em") { + // if (true || (node.text().length() > 50 && node.text().count(" ") > 10) || (!node.nextSibling().text().startsWith("\\s*\\n"))) { + mdItem += "*${node.text()}*" + // } else { + // mdItem += "### "+node.text() + // } + } else if (node.nodeName().toLowerCase() == "br") { + mdItem += "
\n" + } else if (node.nodeName().toLowerCase() == "a") { + mdItem += "[${node.text()}](${node.attr('href')})" + } + } + if (!addedIssues) { + mdItem += issuesLink + } + list += mdItem.stripTrailing()+"\n" + } else if (e.tagName().toLowerCase() == "div") { + e.children().each { eee -> + list += ulToList(eee, indent) + } + } else if (e.tagName().toLowerCase() == "strong") { + list += "**${e.text()}**" + } else if (e.tagName().toLowerCase() == "em") { + if (e.text().length() > 50 && e.text().count(" ") > 20) { + list += "*${e.text()}*" + } else { + list += "\n\n### ${e.text()}\n\n" + } + } + } + return list +} + +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) { + try { + 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." : "" + } catch(Exception e) { + summary = "" + } + } + + [1,2].each { col -> + def colChanges = "" + if (headings[col] != null && headings[col].size() > 0) { + releaseCells[col].children().each { e -> + if (e.tagName().toLowerCase() == "ul" || e.tagName().toLowerCase() == "div") { + if (colChanges != "") { + colChanges = colChanges.stripTrailing() + "\n" + } + colChanges += ulToList(e, 0) + } else if (e.tagName().toLowerCase() == "em") { + colChanges += "\n\n### ${e.text()}\n\n" + } + } + } + if (colChanges != "") { + def className = headings[col].replaceAll(" ","_").toLowerCase().replaceAll("[^_a-z]","") + changes += "
\n\n## ${headings[col]}\n\n${colChanges}\n
\n\n" + } + } + + if (changes != "") { + changes = "
\n\n${changes}\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 + // summary in version archive release pages only appears from 2.10.2b2 onwards + if (oldDate.format("yyyy") as Integer >= 2019 || JALVIEW_VERSION.startsWith("2.10")) { + def summaryFile = file("${jalviewDir}/${whatsnew_dir}/whatsnew-${JALVIEW_VERSION_UNDERSCORES}.md") + if (summaryFile.exists()) { + summary = summaryFile.text + } else { + summary = "" + } + content = content.replaceAll("__SUMMARY__", summary) + } else { + content = content.replaceAll("__SUMMARY__", "") + } + content = content.replaceAll("__CHANGES__", changes) + if (oldDate != null) { + if (oldDate[java.util.Calendar.YEAR] < 90) { + oldDate[java.util.Calendar.YEAR] += 2000 + } + 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 {