X-Git-Url: http://source.jalview.org/gitweb/?p=jalview.git;a=blobdiff_plain;f=build.gradle;h=18af7978ae859799f904ad773c65168285b69451;hp=a6d0e779b80c6e96392e2f8c0cd9215a67c38c32;hb=5e5545a5a719207cdab4c9b16baf7cd18c16bfba;hpb=a55b066dfc2bae86cf321b83a5a0731de9de16be
diff --git a/build.gradle b/build.gradle
index a6d0e77..18af797 100644
--- a/build.gradle
+++ b/build.gradle
@@ -2388,87 +2388,69 @@ task dataInstallersJson {
}
}
-def hugoTemplateSubstitutions(String input) {
+def hugoTemplateSubstitutions(String input, Map extras=null) {
+ def replacements = [
+ DATE: getDate("yyyy-MM-dd"),
+ CHANNEL: propertiesChannelName,
+ APPLICATION_NAME: applicationName,
+ GIT_HASH: gitHash,
+ GIT_BRANCH: gitBranch,
+ VERSION: JALVIEW_VERSION,
+ JAVA_VERSION: JAVA_VERSION,
+ VERSION_UNDERSCORES: JALVIEW_VERSION_UNDERSCORES,
+ DRAFT: "false",
+ JVL_HEADER: ""
+ ]
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)
+ if (extras != null) {
+ extras.each{ k, v ->
+ output = output.replaceAll("__${k}__", ((v == null)?"":v))
+ }
+ }
+ replacements.each{ k, v ->
+ output = output.replaceAll("__${k}__", ((v == null)?"":v))
+ }
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 mdFileComponents(File mdFile, def dateOnly=false) {
+ def map = [:]
+ def content = ""
+ if (mdFile.exists()) {
+ def inFrontMatter = false
+ def firstLine = true
+ mdFile.eachLine { line ->
+ if (line.matches("---")) {
+ def prev = inFrontMatter
+ inFrontMatter = firstLine
+ if (inFrontMatter != prev)
+ return false
}
- 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 (inFrontMatter) {
+ def m = null
+ if (m = line =~ /^date:\s*(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2})/) {
+ map["date"] = new Date().parse("yyyy-MM-dd HH:mm:ss", m[0][1])
+ } else if (m = line =~ /^date:\s*(\d{4}-\d{2}-\d{2})/) {
+ map["date"] = new Date().parse("yyyy-MM-dd", m[0][1])
+ } else if (m = line =~ /^channel:\s*(\S+)/) {
+ map["channel"] = m[0][1]
+ } else if (m = line =~ /^version:\s*(\S+)/) {
+ map["version"] = m[0][1]
+ } else if (m = line =~ /^\s*([^:]+)\s*:\s*(\S.*)/) {
+ map[ m[0][1] ] = m[0][2]
+ }
+ if (dateOnly && map["date"] != null) {
+ return false
}
- }
- 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"
+ if (dateOnly)
+ return false
+ content += line+"\n"
}
+ firstLine = false
}
}
- return list
+ return dateOnly ? map["date"] : [map, content]
}
task hugoTemplates {
@@ -2478,104 +2460,72 @@ task hugoTemplates {
def hugoTemplatesDir = file("${jalviewDir}/${hugo_templates_dir}")
def hugoBuildDir = "${jalviewDir}/${hugo_build_dir}"
def templateFiles = fileTree(dir: hugoTemplatesDir)
+ def releaseMdFile = file("${jalviewDir}/${releases_dir}/release-${JALVIEW_VERSION_UNDERSCORES}.md")
+ def whatsnewMdFile = file("${jalviewDir}/${whatsnew_dir}/whatsnew-${JALVIEW_VERSION_UNDERSCORES}.md")
+ def oldJvlFile = file("${jalviewDir}/${hugo_old_jvl}")
doFirst {
// specific release template for version archive
- def summary = "${applicationName} ${JALVIEW_VERSION}"
def changes = ""
- def oldDate = null
+ def whatsnew = null
+ def givenDate = null
+ def givenChannel = null
+ def givenVersion = 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
- }
+ def (map, content) = mdFileComponents(releaseMdFile)
+ givenDate = map.date
+ givenChannel = map.channel
+ givenVersion = map.version
+ changes = content
+ if (givenVersion != null && givenVersion != JALVIEW_VERSION) {
+ throw new GradleException("'version' header (${givenVersion}) found in ${releaseMdFile} does not match JALVIEW_VERSION (${JALVIEW_VERSION})")
}
- 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 = ""
- }
- }
+ if (whatsnewMdFile.exists())
+ whatsnew = whatsnewMdFile.text
+ }
- [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"
- }
- }
+ def oldJvl = oldJvlFile.exists() ? oldJvlFile.collect{it} : []
- if (changes != "") {
- changes = "\n\n${changes}\n\n
"
+ def changesHugo = null
+ if (changes != null) {
+ changesHugo = '\n\n'
+ def inSection = false
+ changes.eachLine { line ->
+ def m = null
+ if (m = line =~ /^##([^#].*)$/) {
+ if (inSection) {
+ changesHugo += "
\n\n"
+ }
+ def section = m[0][1].trim()
+ section = section.toLowerCase()
+ section = section.replaceAll(/ +/, "_")
+ section = section.replaceAll(/[^a-z0-9_\-]/, "")
+ changesHugo += "\n\n"
+ inSection = true
+ } else if (m = line =~ /^(\s*-\s*)(.*?)()?\s*$/) {
+ def comment = m[0][2].trim()
+ if (comment != "") {
+ comment = comment.replaceAll('"', """)
+ def issuekeys = []
+ comment.eachMatch(/JAL-\d+/) { jal -> issuekeys += jal }
+ def newline = m[0][1]
+ if (comment.trim() != "")
+ newline += "{{}}${comment}{{}} "
+ newline += m[0][3].trim()
+ if (issuekeys.size() > 0)
+ newline += " {{< jal issue=\"${issuekeys.join(",")}\" alt=\"${comment}\" >}}"
+ if (m[0][4] != null)
+ newline += m[0][4]
+ line = newline
}
}
+ changesHugo += line+"\n"
}
+ if (inSection) {
+ changesHugo += "\n
\n\n"
+ }
+ changesHugo += ''
}
templateFiles.each{ templateFile ->
@@ -2584,7 +2534,7 @@ task hugoTemplates {
def newRelPathName = hugoTemplateSubstitutions( relPath.toString() )
def outPathName = string("${hugoBuildDir}/$newRelPathName")
-
+
copy {
from templateFile
rename(templateFile.getName(), newFileName)
@@ -2593,28 +2543,109 @@ task hugoTemplates {
def newFile = file("${outPathName}/${newFileName}".toString())
def content = newFile.text
- // summary in version archive release pages only appears from 2.10.5 onwards
- if (oldDate.format("yyyy") as Integer >= 2019 || JALVIEW_VERSION == "2.10.5") {
- 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)
+ newFile.text = hugoTemplateSubstitutions(content,
+ [
+ WHATSNEW: whatsnew,
+ CHANGES: changesHugo,
+ DATE: givenDate == null ? "" : givenDate.format("yyyy-MM-dd"),
+ DRAFT: givenDate == null ? "true" : "false",
+ JVL_HEADER: oldJvl.contains(JALVIEW_VERSION) ? "jvl: true" : ""
+ ]
+ )
}
+
}
+ inputs.file(oldJvlFile)
inputs.dir(hugoTemplatesDir)
inputs.property("JALVIEW_VERSION", { JALVIEW_VERSION })
inputs.property("CHANNEL", { CHANNEL })
}
+def getMdDate(File mdFile) {
+ return mdFileComponents(mdFile, true)
+}
+
+def getMdSections(String content) {
+ def sections = [:]
+ def sectionContent = ""
+ def sectionName = null
+ content.eachLine { line ->
+ def m = null
+ if (m = line =~ /^##([^#].*)$/) {
+ if (sectionName != null) {
+ sections[sectionName] = sectionContent
+ sectionName = null
+ sectionContent = ""
+ }
+ sectionName = m[0][1].trim()
+ sectionName = sectionName.toLowerCase()
+ sectionName = sectionName.replaceAll(/ +/, "_")
+ sectionName = sectionName.replaceAll(/[^a-z0-9_\-]/, "")
+ } else if (sectionName != null) {
+ sectionContent += line+"\n"
+ }
+ }
+ return sections
+}
+
+task releasesTemplates {
+ 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 releasesMdDir = "${jalviewDir}/${releases_dir}"
+ def whatsnewMdDir = "${jalviewDir}/${whatsnew_dir}"
+
+ doFirst {
+ def releaseFiles = fileTree(dir: releasesMdDir, include: "release-*.md")
+ def releaseFilesDates = releaseFiles.collectEntries {
+ [(it): getMdDate(it)]
+ }
+ releaseFiles = releaseFiles.sort { a,b -> releaseFilesDates[a].compareTo(releaseFilesDates[b]) }
+
+ def releasesTemplate = releasesTemplateFile.text
+ def m = releasesTemplate =~ /(?s)__VERSION_LOOP_START__(.*)__VERSION_LOOP_END__/
+ def versionTemplate = m[0][1]
+
+ def versions = ""
+ releaseFiles.each { rFile ->
+ def (rMap, rContent) = mdFileComponents(rFile)
+
+ def vm = JALVIEW_VERSION =~ /^(.+)\.(\d+)$/
+ def branchVersion = m[0][1]
+ def minorVersion = m[0][2]
+ def displayDate = releaseFilesDates[rFile].format("d MMMMM yyyy")
+
+ def rContentSections = getMdSections(rContent)
+
+ def rVersion = versionTemplate
+ if (rVersion != "") {
+ rVersion = hugoTemplateSubstitutions(rVersion,
+ [
+ BRANCH_VERSION: branchVersion,
+ MINOR_VERSION: minorVersion,
+ DISPLAY_DATE: displayDate,
+ NEW_FEATURES: rContentSections["new_features"],
+ KNOWN_ISSUES: rContentSections["known_issues"]
+ ]
+ )
+ }
+
+ println("RVERSION='$rVersion'")
+
+
+ }
+ }
+
+ inputs.file(releasesTemplateFile)
+ inputs.file(whatsnewTemplateFile)
+ inputs.dir(releasesMdDir)
+ inputs.dir(whatsnewMdDir)
+ outputs.file(releasesHtmlFile)
+ outputs.file(whatsnewHtmlFile)
+}
+
task helppages {
dependsOn copyHelp