Merge pull request #15 from adriaanm/master

merge improvements to git parsing from 2.9.x to master

Author: jsuereth

README.md

@@ -1,6 +1,6 @@
 # Scala Release Notes Creator
 
-This project generates the HTML release notes for Scala.   It's goal is to be minimal and sufficient.   Not an ideal example of scala code,
+This project generates the HTML release notes for Scala.   Its goal is to be minimal and sufficient.   Not an ideal example of Scala code,
 but perhaps shows off a few standard library APIs.
 
 
@@ -12,7 +12,7 @@ For now, it's still mostly manual.   What you need to do:
 2. Update the highlights notes in `hand-written.md`.
 3. run `sbt console`, and then the following:
 
-    scala> MakeReleaseNotes(new java.io.File("/path/to/scala/checkout"), "v2.9.2", "v2.10.0-RC3")
+    scala> MakeReleaseNotes(new java.io.File("~/git/scala"), "v2.9.2", "v2.9.3")
 
 where the two strings are the tags to compare.
 

build.sbt

@@ -3,3 +3,5 @@ name := "scala-release-note-generator"
 scalaVersion := "2.10.0-RC3"
 
 libraryDependencies += "org.pegdown" % "pegdown" % "1.2.0"
+
+libraryDependencies += "org.apache.commons" % "commons-lang3" % "3.1"

hand-written.md

@@ -1,19 +1,23 @@
-We are pleased to announce the first release candidate of Scala 2.10.1!
+We are pleased to announce the second release candidate of Scala 2.10.1!
 
-The Scala team and contributors [fixed 177 issues since 2.10.0](https://issues.scala-lang.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+SI+AND+fixVersion+%3D+%22Scala+2.10.1-RC1%22+AND+status+%3D+closed+ORDER+BY+priority+DESC)!
-In total, [242 pull requests](https://github.com/scala/scala/issues?milestone=5&page=1&state=closed) were opened on [GitHub](https://github.com/scala/scala), of which [225 were merged](https://gist.github.com/adriaanm/4760366) after having been [tested](https://github.com/typesafehub/ghpullrequest-validator) and reviewed.
+The Scala team and contributors [fixed 184 issues since 2.10.0](https://issues.scala-lang.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+SI+AND+%28fixVersion+%3D+%22Scala+2.10.1-RC1%22+OR+fixVersion+%3D+%22Scala+2.10.1-RC2%22%29+AND+status+%3D+closed+ORDER+BY+priority+DESC)!
+In total, [242 pull requests](https://github.com/scala/scala/issues?milestone=5&page=1&state=closed) (+ [7 for RC2](https://github.com/scala/scala/issues?milestone=13&page=1&state=closed)) were opened on [GitHub](https://github.com/scala/scala), of which [225 were merged](https://gist.github.com/adriaanm/4760366) (+ 6 for RC2) after having been [tested](https://github.com/typesafehub/ghpullrequest-validator) and reviewed.
 
-Please give 2.10.1-RC1 a spin! It's designed to be a drop-in replacement for 2.10.0.
+Please give 2.10.1-RC2 a spin! It's designed to be a drop-in replacement for 2.10.0.
 We'd love to hear about any regressions since 2.10.0 and will try to fix them before releasing the final version.
 
+There will be an RC3 one week after this release, which will become the final unless new blocker issues are discovered within a week after its release.
+
+<!--break-->
+
 ### Known Issues
-Before reporting a bug, please have a look at these known issues scheduled [for 2.10.1-RC2](https://issues.scala-lang.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+SI+AND+fixVersion+%3D+%22Scala+2.10.1-RC2%22+AND+resolution+%3D+Unresolved++ORDER+BY+priority+DESC%2C+key+DESC).
+Before reporting a bug, please have a look at these known issues scheduled [for 2.10.1-RC3](https://issues.scala-lang.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+SI+AND+fixVersion+%3D+%22Scala+2.10.1-RC3%22+AND+resolution+%3D+Unresolved++ORDER+BY+priority+DESC%2C+key+DESC).
 
 ### Scala IDE for Eclipse
-The Scala IDE with Scala 2.10.1-RC1 built right in is available through one of the following update-sites:
+The Scala IDE with Scala 2.10.1-RC2 built right in is available through one of the following update-sites:
 
-* [for Eclipse 3.7 (Indigo)](http://download.scala-ide.org/sdk/next/e37/scala210/dev/site/)
-* [for Eclipse 3.8/4.2 (Juno)](http://download.scala-ide.org/sdk/next/e38/scala210/dev/site/) (Support for this version is experimental.)
+* [for Eclipse 3.7 (Indigo)](http://download.scala-ide.org/sdk/e37/scala210/dev/site/)
+* [for Eclipse 3.8/4.2 (Juno)](http://download.scala-ide.org/sdk/e38/scala210/dev/site/) (Support for this version is experimental.)
 
 Have a look at the [getting started guide](http://scala-ide.org/docs/user/gettingstarted.html) for more info.
 

release-notes.html

@@ -6,11 +6,17 @@ case class Commit(sha: String, author: String, header: String, body: String) {
 
 /** Gobal functions for dealing with git. */
 object GitHelper {
-  val gitFormat = "--format=format:*-*%h``%aN``%s``%b"
-  def processGitCommits(input: String): IndexedSeq[Commit] =
-    input.lines.map(_.split("``", 4)).collect {
-      case Array(sha, author, hdr, msg) => Commit(sha, author, hdr, msg)
+  def processGitCommits(gitDir: java.io.File, previousTag: String, currentTag: String): IndexedSeq[Commit] = {
+    import sys.process._
+    val gitFormat = "%h %s" // sha and subject
+    val log = Process(Seq("git", "--no-pager", "log", s"${previousTag}..${currentTag}","--format=format:"+gitFormat,"--no-merges", "--topo-order"), gitDir).lines
+
+    log.par.map(_.split(" ", 2)).collect {
+      case Array(sha, title) =>
+        val (author :: body) = Process(Seq("git", "--no-pager", "show", sha ,"--format=format:%aN%n%b","--quiet"), gitDir).lines.toList
+        Commit(sha, author, title, body.mkString("\n"))
     }.toVector
+  }
 
   def hasFixins(msg: String): Boolean = (
     (msg contains "SI-") /*&& ((msg.toLowerCase contains "fix") || (msg.toLowerCase contains "close"))*/
@@ -28,14 +34,12 @@ object GitHelper {
     issues map (si => """<a href="https://issues.scala-lang.org/browse/%s">%s</a>""" format (si, si)) mkString ", "
   }
 
+  def htmlEncode(s: String) = org.apache.commons.lang3.StringEscapeUtils.escapeHtml4(s)
 }
 
 class GitInfo(gitDir: java.io.File, val previousTag: String, val currentTag: String) {
-  import sys.process._
   import GitHelper._
-  
-  def runGit =  Process(Seq("git", "log", s"${previousTag}..${currentTag}","--format=format:%h``%aN``%s``%b","--no-merges"), gitDir)
-  val commits = processGitCommits(runGit.!!)
+  val commits = processGitCommits(gitDir, previousTag, currentTag)
 
   val authors: Seq[(String, Int)] = {
     val grouped: Vector[(String,Int)] = (commits groupBy (_.author)).map { case (a,c) => a -> c.length }{collection.breakOut}
@@ -63,7 +67,7 @@ class GitInfo(gitDir: java.io.File, val previousTag: String, val currentTag: Str
                  |  <thead><tr><th>#</th><th align="left">Author</th></tr></thead>
                  |<tbody>""".stripMargin
     for((author, count) <- authors)
-      sb append s"""<tr><td align="right">${count} &nbsp;</td><td>${author}</td></tr>"""
+      sb append s"""<tr><td align="right">${count} &nbsp;</td><td>${htmlEncode(author)}</td></tr>"""
     sb append """</tbody></table>"""
     sb.toString
   }
@@ -76,7 +80,7 @@ class GitInfo(gitDir: java.io.File, val previousTag: String, val currentTag: Str
       <thead><tr><th>sha</th><th align="left">Title</th></tr></thead>
     <tbody>"""
     for(commit <- commits)
-       sb append s"""<tr><td align="right">${commitShaLink(commit.sha)}&nbsp;</td><td>${commit.header}</td></tr>"""
+       sb append s"""<tr><td align="right">${commitShaLink(commit.sha)}&nbsp;</td><td>${htmlEncode(commit.header)}</td></tr>"""
     sb append """</tbody>
       </table>"""
     sb.toString
@@ -90,7 +94,7 @@ class GitInfo(gitDir: java.io.File, val previousTag: String, val currentTag: Str
       <thead><tr><th>Issue(s)</th><th>Commit</th><th>Message</th></tr></thead>
     <tbody>""")
     for(commit <- fixCommits)
-      sb append s"""<tr><td>${fixLinks(commit)}&nbsp;</td><td>${commitShaLink(commit.sha)}&nbsp;</td><td>${commit.header}</td></tr>"""
+      sb append s"""<tr><td>${fixLinks(commit)}&nbsp;</td><td>${commitShaLink(commit.sha)}&nbsp;</td><td>${htmlEncode(commit.header)}</td></tr>"""
     sb append """</tbody>
       </table>"""
     sb append blankLine()

src/main/scala/GitInfo.scala

@@ -34,16 +34,18 @@ object MakeReleaseNotes {
 
   def makeReleaseNotes(scalaDir: java.io.File, previousTag: String, currentTag: String): String = {
     val info = new GitInfo(scalaDir, previousTag, currentTag)
-    val communityProjects = CommunityProjects.loadHtmlFromFile()
+    // val communityProjects = CommunityProjects.loadHtmlFromFile()
     import info.{currentTag => _, _}
+    // <h3> Known issues </h3>
+    // ${JiraIssues.makeOpenIssuesString}
+
     s"""<html>
       <head>
         <title>${currentTag} - Release notes</title>
       </head>
       <body>
         <h3>Scala ${currentTag drop 1} is now available!</h3>
         ${parseHandWrittenNotes()}
-        ${communityProjects}
         <br/><br/>
         ${renderCommitterList}
         ${renderFixedIssues}