feat: auto generate release notes for next release (#996)

* Added generation of release notes

* added tests

* updated documentation

* Delete next release notes

Author: piotradamczyk5

.github/pull_request_template.md

@@ -9,4 +9,3 @@ Fixes #
 
 - [ ] Documented
 - [ ] Unit tested
-- [ ] release_notes.md updated

.github/workflows/release_notes_generation.yml

@@ -0,0 +1,40 @@
+name: "Generate release notes for next commit"
+
+on: 
+  workflow_dispatch:
+
+jobs:
+  generateReleaseNotes:
+    runs-on: macos-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Gradle Build flankScripts and add it to PATH
+      run: |
+        ./flank-scripts/bash/buildFlankScripts.sh
+        echo "::add-path::./flank-scripts/bash"
+
+    - name: Set next release tag variable
+      run: |
+        TAG=$(flankScripts ci nextReleaseTag --token=${{ secrets.GITHUB_TOKEN }})
+        echo "::set-env name=NEXT_RELEASE_TAG::$(echo $TAG)";
+
+    - name: Append release note
+      run: |
+        flankScripts ci generateReleaseNotes --token=${{ secrets.GITHUB_TOKEN }}
+
+    - name: Commit files and create Pull request
+      id: pr
+      uses: peter-evans/create-pull-request@v3
+      with:
+        commit-message: "[Automatic PR] Generate release notes"
+        signoff: false
+        branch: 'release/${{ env.NEXT_RELEASE_TAG }}'
+        title: 'chore: release notes for ${{ env.NEXT_RELEASE_TAG }}'
+        body: "Auto generated release notes for `${{ env.NEXT_RELEASE_TAG }}` by @${{ github.actor }}"
+        labels: |
+          automated pr
+          release
+        reviewers: bootstraponline,jan-gogo,pawelpasterz,adamfilipow92,piotradamczyk5,Sloox
+        draft: false

flank-scripts/README.md

@@ -19,6 +19,29 @@ If you need help with available commands or arguments you could always use optio
 
 ## Available commands and options
 
+### CI
+To show all available commands for ci use:
+`flankScripts ci`
+
+Available commands are:
+  - `generateReleaseNotes`  Command to generate release notes and append them to `release_notes.md`
+  - `nextReleaseTag`        Print next release tag
+  
+#### `generateReleaseNotes`
+Command to generate release notes and append them to `release_notes.md`
+
+| Option               	| Description                                             	|
+|----------------------	|---------------------------------------------------------	|
+| --token              	| Git token                                               	|
+| --release-notes-file 	| Path to release_notes.md (default `./release_notes.md`) 	|
+
+#### `nextReleaseTag`
+Print next release tag
+
+| Option          	| Description     	|
+|-----------------	|-----------------	|
+| `--token`       	| Git token       	|
+
 ### Release 
 The release process was described in [document](../docs/release_process.md).  
 To show all available commands for release use:

flank-scripts/src/main/kotlin/flank/scripts/Main.kt

@@ -2,6 +2,7 @@ package flank.scripts
 
 import com.github.ajalt.clikt.core.CliktCommand
 import com.github.ajalt.clikt.core.subcommands
+import flank.scripts.ci.CiCommand
 import flank.scripts.release.ReleaseCommand
 
 class Main : CliktCommand(name = "flankScripts") {
@@ -10,6 +11,7 @@ class Main : CliktCommand(name = "flankScripts") {
 }
 
 fun main(args: Array<String>) {
-    Main().subcommands(ReleaseCommand())
-            .main(args)
+    Main()
+        .subcommands(ReleaseCommand(), CiCommand())
+        .main(args)
 }

flank-scripts/src/main/kotlin/flank/scripts/ci/CiCommand.kt

@@ -0,0 +1,16 @@
+package flank.scripts.ci
+
+import com.github.ajalt.clikt.core.CliktCommand
+import com.github.ajalt.clikt.core.subcommands
+import flank.scripts.ci.nexttag.NextReleaseTagCommand
+import flank.scripts.ci.releasenotes.GenerateReleaseNotesCommand
+
+class CiCommand : CliktCommand(help = "Contains command related to CI", name = "ci") {
+
+    init {
+        subcommands(GenerateReleaseNotesCommand(), NextReleaseTagCommand())
+    }
+
+    @Suppress("EmptyFunctionBlock")
+    override fun run() {}
+}

flank-scripts/src/main/kotlin/flank/scripts/ci/nexttag/NextReleaseTagCommand.kt

@@ -0,0 +1,30 @@
+package flank.scripts.ci.nexttag
+
+import com.github.ajalt.clikt.core.CliktCommand
+import com.github.ajalt.clikt.parameters.options.option
+import com.github.ajalt.clikt.parameters.options.required
+import com.github.kittinunf.result.Result
+import flank.scripts.github.getLatestReleaseTag
+import kotlin.system.exitProcess
+import kotlinx.coroutines.runBlocking
+
+class NextReleaseTagCommand : CliktCommand(help = "Print next release tag", name = "nextReleaseTag") {
+
+    private val token by option(help = "Git Token").required()
+
+    override fun run() {
+        runBlocking {
+            getNextReleaseTagCommand(token)
+        }
+    }
+}
+
+private suspend fun getNextReleaseTagCommand(token: String) {
+    when (val result = getLatestReleaseTag(token)) {
+        is Result.Success -> println(generateNextReleaseTag(result.value.tag))
+        is Result.Failure -> {
+            println(result.error)
+            exitProcess(1)
+        }
+    }
+}

flank-scripts/src/main/kotlin/flank/scripts/ci/nexttag/NextReleaseTagGenerator.kt

@@ -0,0 +1,20 @@
+package flank.scripts.ci.nexttag
+
+import java.time.LocalDate
+import java.time.Year
+import java.time.format.DateTimeFormatter
+
+fun generateNextReleaseTag(previousReleaseTag: String): String {
+    val (year, month, number) = previousReleaseTag.trimStart('v').split('.')
+    return if (isNextReleaseInCurrentMonth(
+            year,
+            month
+        )
+    ) "v$year.$month.${number.toInt() + 1}" else currentMonthFirstTag()
+}
+
+private fun isNextReleaseInCurrentMonth(year: String, month: String) =
+    DateTimeFormatter.ofPattern("yy").format(Year.now()) == year &&
+        DateTimeFormatter.ofPattern("MM").format(LocalDate.now()) == month
+
+private fun currentMonthFirstTag() = "v${DateTimeFormatter.ofPattern("yy.MM").format(LocalDate.now())}.0"

flank-scripts/src/main/kotlin/flank/scripts/ci/releasenotes/AppendReleaseNotes.kt

@@ -0,0 +1,24 @@
+package flank.scripts.ci.releasenotes
+
+import flank.scripts.utils.markdownH2
+import java.io.File
+
+fun File.appendReleaseNotes(messages: List<String>, releaseTag: String) {
+    appendToReleaseNotes(
+        messages = messages,
+        releaseTag = releaseTag
+    )
+}
+
+private fun File.appendToReleaseNotes(messages: List<String>, releaseTag: String) {
+    val currentFileLines = readLines()
+    val newLines = mutableListOf<String>().apply {
+        add(releaseTag.markdownH2())
+        addAll(messages)
+        add("")
+    }
+
+    writeText((newLines + currentFileLines).joinToString(System.lineSeparator()).withNewLineAtTheEnd())
+}
+
+private fun String.withNewLineAtTheEnd() = plus(System.lineSeparator())

flank-scripts/src/main/kotlin/flank/scripts/ci/releasenotes/ConventionalCommitFormatter.kt

@@ -0,0 +1,14 @@
+package flank.scripts.ci.releasenotes
+
+import flank.scripts.utils.markdownBold
+
+fun String.mapPrTitle() = when {
+    startsWith("feat") -> replaceFirst("feat", "New feature".markdownBold())
+    startsWith("fix") -> replaceFirst("fix", "Fix".markdownBold())
+    startsWith("docs") -> replaceFirst("docs", "Documentation".markdownBold())
+    startsWith("refactor") -> replaceFirst("refactor", "Refactor".markdownBold())
+    startsWith("ci") -> replaceFirst("ci", "CI changes".markdownBold())
+    startsWith("test") -> replaceFirst("test", "Tests update".markdownBold())
+    startsWith("perf") -> replaceFirst("perf", "Performance upgrade".markdownBold())
+    else -> null // we do not accept other prefix to have update in release notes
+}

flank-scripts/src/main/kotlin/flank/scripts/ci/releasenotes/GenerateChangeLog.kt

@@ -0,0 +1,36 @@
+package flank.scripts.ci.releasenotes
+
+import com.github.kittinunf.result.Result
+import flank.scripts.github.getPrDetailsByCommit
+import flank.scripts.utils.markdownLink
+import flank.scripts.utils.runCommand
+import java.io.File
+import kotlinx.coroutines.async
+import kotlinx.coroutines.awaitAll
+import kotlinx.coroutines.runBlocking
+
+fun generateReleaseNotes(latestReleaseTag: String, githubToken: String) = getCommitsSha(latestReleaseTag).getReleaseNotes(githubToken)
+
+internal fun getCommitsSha(fromTag: String): List<String> {
+    val outputFile = File.createTempFile("sha", ".log")
+
+    "git log --pretty=%H $fromTag..HEAD".runCommand(fileForOutput = outputFile)
+
+    return outputFile.readLines()
+}
+
+private fun List<String>.getReleaseNotes(githubToken: String) = runBlocking {
+    map { sha -> async { getPrDetailsByCommit(sha, githubToken) } }
+        .awaitAll()
+        .filterIsInstance<Result.Success<List<GithubPullRequest>>>()
+        .map { it.value }
+        .filter { it.isNotEmpty() }
+        .mapNotNull { it.first().toReleaseNoteMessage() }
+}
+
+private fun GithubPullRequest.toReleaseNoteMessage() =
+    title.mapPrTitle()?.let { title ->
+        "- ${markdownLink(number.toString(), htmlUrl)} $title ${assignees.format()}"
+    }
+
+private fun List<GithubUser>.format() = "(${joinToString { (login, url) -> markdownLink(login, url) }})"