Collect release notes from commits (#322)

## What is the goal of this PR?

We've updated the release notes script to collect from commits rather than milestones. It will collect the commits between the last release up to the specified commit being released.

Additionally, it's been rewritten in Kotlin.

## What are the changes implemented in this PR?

1. Update the script for collecting release note from commits, which works as follows:
    - given C1, the commit that we want to release, collect L, the list of commits that we want to add to the release note:
      - if this is the first release ever, L would contain all the commits from C1 down to and including the first commit in the repo
      - if this is not the first release:
        - find C2, the commit of the release that immediately precedes this release
        - L would contain all the commits from C1 down to but excluding C2
    - write PR description or commit message for each commit in L into the release note
2. Rewrite in Kotlin

Author: Ganeshwara Hananda

RELEASE_TEMPLATE.md

@@ -1 +1 @@
-{ release notes }
+{ release notes }

tool/release/BUILD

@@ -29,20 +29,6 @@ py_binary(
     main = "docs.py"
 )
 
-py_binary(
-    name = "create-notes",
-    srcs = ["create-notes.py"],
-    main = "create-notes.py",
-    deps = [
-        requirement("PyGithub"),
-        requirement("urllib3"),
-        requirement("chardet"),
-        requirement("idna"),
-        requirement("wrapt"),
-        requirement("certifi"),
-    ]
-)
-
 kt_jvm_binary(
     name = "bump",
     srcs = ["Bump.kt"],

tool/release/create-notes.py

@@ -0,0 +1,33 @@
+#
+# Copyright (C) 2021 Vaticle
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+load("@io_bazel_rules_kotlin//kotlin:kotlin.bzl", "kt_jvm_binary")
+
+kt_jvm_binary(
+    name = "bin",
+    srcs = glob(["*.kt"]),
+    main_class = "com.vaticle.dependencies.tool.release.createnotes.MainKt",
+    deps = [
+        "@maven//:com_eclipsesource_minimal_json_minimal_json",
+        "@maven//:com_google_http_client_google_http_client",
+        "@maven//:org_zeroturnaround_zt_exec",
+    ],
+)

tool/release/createnotes/BUILD

@@ -0,0 +1,58 @@
+/*
+ * Copyright (C) 2021 Vaticle
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.vaticle.dependencies.tool.release.createnotes
+
+import com.eclipsesource.json.Json
+import com.vaticle.dependencies.tool.release.createnotes.Constant.github
+import java.nio.file.Path
+
+fun getCommits(org: String, repo: String, current: Version, to: String, baseDir: Path, githubToken: String): List<String> {
+    val preceding = getPrecedingVersion(org, repo, current, githubToken)
+    if (preceding != null) {
+        val response = httpGet("$github/repos/$org/$repo/compare/$preceding...$to", githubToken)
+        val body = Json.parse(String(response.content.readBytes()))
+        return body.asObject().get("commits").asArray().map { e -> e.asObject().get("sha").asString() }
+    }
+    else {
+        val gitRevList = bash("git rev-list --max-parents=0 HEAD", baseDir)
+        val firstCommit = gitRevList.outputString().trim()
+        val response = httpGet("$github/repos/$org/$repo/compare/$firstCommit...$to", githubToken)
+        val body = Json.parse(String(response.content.readBytes()))
+        return listOf(firstCommit) + body.asObject().get("commits").asArray().map { e -> e.asObject().get("sha").asString() }.toList()
+    }
+}
+
+private fun getPrecedingVersion(org: String, repo: String, current: Version, githubToken: String): Version? {
+    val response = httpGet("$github/repos/$org/$repo/releases", githubToken)
+    val body = Json.parse(String(response.content.readBytes()))
+    val releases = mutableListOf<Version>()
+    releases.add(current)
+    releases.addAll(body.asArray().map { e -> Version.parse(e.asObject().get("tag_name").asString()) })
+    releases.sort()
+    val currentIdx = releases.indexOf(current)
+    val preceding =
+        if (currentIdx >= 1) releases[currentIdx - 1]
+        else if (currentIdx == 0) null
+        else throw IllegalStateException("")
+    println("preceding version: $preceding")
+    return preceding
+}

tool/release/createnotes/Commit.kt

@@ -0,0 +1,71 @@
+/*
+ * Copyright (C) 2021 Vaticle
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.vaticle.dependencies.tool.release.createnotes
+
+import com.eclipsesource.json.Json
+import com.vaticle.dependencies.tool.release.createnotes.Constant.labelBug
+import com.vaticle.dependencies.tool.release.createnotes.Constant.labelFeature
+import com.vaticle.dependencies.tool.release.createnotes.Constant.github
+import com.vaticle.dependencies.tool.release.createnotes.Constant.labelPrefix
+import com.vaticle.dependencies.tool.release.createnotes.Constant.labelRefactor
+
+data class CommitDescription(val title: String, val desc: String, val type: Type) {
+    enum class Type { FEATURE, BUG, REFACTOR, OTHER }
+}
+
+fun getCommitDescriptions(org: String, repo: String, commits: List<String>, githubToken: String): List<CommitDescription> {
+    return commits.flatMap { commit ->
+
+        val response = httpGet("$github/repos/$org/$repo/commits/$commit/pulls", githubToken)
+        val body = Json.parse(String(response.content.readBytes()))
+        val prs = body.asArray()
+        if (prs.size() > 0) {
+            val notes = prs.map { pr ->
+                val prNumber = pr.asObject().get("number").asInt()
+                println("collecting commit '$commit' from PR #$prNumber...")
+                val types = pr.asObject().get("labels").asArray().map { e -> e.asObject().get("name").asString() }
+                    .filter { e -> e.startsWith(labelPrefix) }
+                val type =
+                    if (types.contains(labelFeature)) CommitDescription.Type.FEATURE
+                    else if (types.contains(labelBug)) CommitDescription.Type.BUG
+                    else if (types.contains(labelRefactor)) CommitDescription.Type.REFACTOR
+                    else CommitDescription.Type.OTHER
+                CommitDescription(
+                    title = pr.asObject().get("title").asString(),
+                    desc = pr.asObject().get("body").asString(),
+                    type = type
+                )
+            }
+            notes
+        } else {
+            println("collecting commit '$commit'...")
+            val response = httpGet("$github/repos/$org/$repo/commits/$commit", githubToken)
+            val body = Json.parse(String(response.content.readBytes()))
+            // only take the first line of the commit message, since the second line onwards are most likely implementation detail
+            val title = body.asObject().get("commit").asObject().get("message").asString().lines().first()
+            val notes = listOf(
+                CommitDescription(title = title, desc = "", type = CommitDescription.Type.OTHER)
+            )
+            notes
+        }
+    }
+}

tool/release/createnotes/CommitDescription.kt

@@ -0,0 +1,41 @@
+package com.vaticle.dependencies.tool.release.createnotes
+
+import com.google.api.client.http.GenericUrl
+import com.google.api.client.http.HttpHeaders
+import com.google.api.client.http.HttpResponse
+import com.google.api.client.http.javanet.NetHttpTransport
+import org.zeroturnaround.exec.ProcessExecutor
+import org.zeroturnaround.exec.ProcessResult
+import java.nio.file.Path
+
+object Constant {
+    val releaseTemplateRegex = "\\{\\s*release notes\\s*}".toRegex()
+    const val installInstruction = "http://docs.vaticle.com/docs/running-typedb/install-and-run"
+    const val github = "https://api.github.com"
+    const val headerAccept = "\"application/vnd.github.v3+json"
+    const val headerAuthPrefix = "Token"
+    const val labelPrefix = "type"
+    const val labelFeature = "$labelPrefix: feature"
+    const val labelBug = "$labelPrefix: bug"
+    const val labelRefactor = "$labelPrefix: refactor"
+}
+
+fun httpGet(url: String, githubToken: String): HttpResponse {
+    return NetHttpTransport()
+        .createRequestFactory()
+        .buildGetRequest(GenericUrl(url))
+        .setHeaders(
+            HttpHeaders().setAuthorization("${Constant.headerAuthPrefix} $githubToken").setAccept(Constant.headerAccept)
+        )
+        .execute()
+}
+
+fun bash(script: String, baseDir: Path): ProcessResult {
+    val builder = ProcessExecutor(script.split(" "))
+        .readOutput(true)
+        .redirectOutput(System.out)
+        .redirectError(System.err)
+        .directory(baseDir.toFile())
+        .exitValueNormal()
+    return builder.execute()
+}

tool/release/createnotes/Common.kt

@@ -0,0 +1,47 @@
+/*
+ * Copyright (C) 2021 Vaticle
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.vaticle.dependencies.tool.release.createnotes
+
+import java.nio.file.Paths
+import kotlin.io.path.notExists
+
+fun main(args: Array<String>) {
+    val bazelWorkspaceDir = Paths.get(getEnv("BUILD_WORKSPACE_DIRECTORY"))
+    val githubToken = getEnv("CREATE_NOTES_TOKEN")
+    if (args.size != 5) throw RuntimeException("org, repo, version, commit, and template must be supplied")
+    val (org, repo, version, commit, templateFileLocation) = args
+    val templateFile = bazelWorkspaceDir.resolve(templateFileLocation)
+    if (templateFile.notExists()) throw RuntimeException("Template file '$templateFile' does not exist.")
+
+    println("Repository: $org/$repo")
+    println("Commit: $commit")
+    println("Version: $version")
+
+    val commits = getCommits(org, repo, Version.parse(version), commit, bazelWorkspaceDir, githubToken)
+    println("There are ${commits.size} commits to be collected.")
+    val commitDescriptions = getCommitDescriptions(org, repo, commits, githubToken)
+    writeReleaseNoteMd(commitDescriptions, templateFile)
+}
+
+private fun getEnv(env: String): String {
+    return System.getenv(env) ?: throw RuntimeException("'$env' environment variable must be set.")
+}