Changelog script. Support cherry-pick PRs (#5321)

Fixes
https://youtrack.jetbrains.com/issue/CMP-8192/Changelog-script.-Handle-multi-cherry-pick-PRs-into-a-release

Now there is a special format for Release Notes, not for the PR.
Example: #5312

- There was an old non-structured way determined it by "Cherry-picked
from ...", it is removed, as it is less convenient (we still need to
define Release Notes)

- We can determine cherry-picks automatically by git, but not always (in
case of conflicts or additional fixes). Because of this, now it is a
requirement either to describe the release notes the usual way or add
links to the original PRs.

## Testing
```
kotlin changelog.main.kts v1.7.3..v1.8.0
kotlin changelog.main.kts v1.8.0..v1.8.1+dev2468
```
Doesn't change old entries, and include new ones

## Release Notes
N/A

---------

Co-authored-by: Victor Kropp <[email protected]>

Author: igordmn

tools/changelog/PR_FORMAT.md

@@ -40,13 +40,22 @@ N/A
 ```
 
 ### Prerelease Fix
-Will be includede in alpha/beta/rc changelog, excluded from stable.
+Will be included in alpha/beta/rc changelog, excluded from stable.
 ```
 ## Release Notes
 ### Fixes - Multiple Platforms
 - _(prerelease fix)_ Fixed CPU overheating on pressing Shift appeared in 1.8.0-alpha02
 ```
 
+### Cherry-picks to a release branch
+The PR can contain only cherry-picks. We can point to them instead of copying the release notes.
+```
+## Release Notes
+https://github.com/JetBrains/compose-multiplatform/pull/5292
+https://github.com/JetBrains/compose-multiplatform/pull/5294
+https://github.com/JetBrains/compose-multiplatform/pull/5295
+```
+
 ## Possible Sections
 <!-- 
 - Note that this is parsed by [changelog.main.kts]

tools/changelog/changelog.main.kts

@@ -200,18 +200,18 @@ fun generateChangelog() {
             append(
                 """
                     ## Dependencies
-            
+
                     - Gradle Plugin `org.jetbrains.compose`, version `$versionCompose`. Based on Jetpack Compose libraries:
                       - [Runtime $versionRedirectingCompose](https://developer.android.com/jetpack/androidx/releases/compose-runtime#$versionRedirectingCompose)
                       - [UI $versionRedirectingCompose](https://developer.android.com/jetpack/androidx/releases/compose-ui#$versionRedirectingCompose)
                       - [Foundation $versionRedirectingCompose](https://developer.android.com/jetpack/androidx/releases/compose-foundation#$versionRedirectingCompose)
                       - [Material $versionRedirectingCompose](https://developer.android.com/jetpack/androidx/releases/compose-material#$versionRedirectingCompose)
                       - [Material3 $versionRedirectingComposeMaterial3](https://developer.android.com/jetpack/androidx/releases/compose-material3#$versionRedirectingComposeMaterial3)
-    
+
                     - Lifecycle libraries `org.jetbrains.androidx.lifecycle:lifecycle-*:$versionLifecycle`. Based on [Jetpack Lifecycle $versionRedirectingLifecycle](https://developer.android.com/jetpack/androidx/releases/lifecycle#$versionRedirectingLifecycle)
                     - Navigation libraries `org.jetbrains.androidx.navigation:navigation-*:$versionNavigation`. Based on [Jetpack Navigation $versionRedirectingNavigation](https://developer.android.com/jetpack/androidx/releases/navigation#$versionRedirectingNavigation)
                     - Material3 Adaptive libraries `org.jetbrains.compose.material3.adaptive:adaptive*:$versionComposeMaterial3Adaptive`. Based on [Jetpack Material3 Adaptive $versionRedirectingComposeMaterial3Adaptive](https://developer.android.com/jetpack/androidx/releases/compose-material3-adaptive#$versionRedirectingComposeMaterial3Adaptive)
-            
+
                     ---
                 """.trimIndent()
             )
@@ -267,7 +267,7 @@ fun checkPr() {
         releaseNotes is ReleaseNotes.Specified && releaseNotes.entries.isEmpty() -> {
             err.println("""
                 "## Release Notes" doesn't contain any items, or "### Section - Subsection" isn't specified
-            
+
                 See the format in $prFormatLink
             """.trimIndent())
             exitProcess(1)
@@ -276,18 +276,18 @@ fun checkPr() {
             err.println("""
                 "## Release Notes" contains nonstandard "Section - Subsection" pairs:
                 ${nonstandardSections.joinToString(", ")}
-            
+
                 Allowed sections: ${standardSections.joinToString(", ")}
                 Allowed subsections: ${standardSubsections.joinToString(", ")}
-            
+
                 See the full format in $prFormatLink
             """.trimIndent())
             exitProcess(1)
         }
         releaseNotes == null -> {
             err.println("""
                 "## Release Notes" section is missing in the PR description
-            
+
                 See the format in $prFormatLink
             """.trimIndent())
             exitProcess(1)
@@ -303,6 +303,11 @@ fun checkPr() {
  */
 fun currentChangelogDate() = LocalDate.now().format(DateTimeFormatter.ofPattern("MMMM yyyy", Locale.ENGLISH))
 
+fun GitHubPullEntry.extractReleaseNotes() = extractReleaseNotes(body, number, htmlUrl)
+
+fun GitHubPullEntry.unknownChangelogEntries() =
+    listOf(ChangelogEntry("- $title", null, null, number, htmlUrl, false))
+
 /**
  * Extract by format [PR_FORMAT.md]
  */
@@ -330,6 +335,14 @@ fun extractReleaseNotes(body: String?, prNumber: Int, prLink: String): ReleaseNo
     if (relNoteBody == null) return null
     if (relNoteBody.trim().lowercase() == "n/a") return ReleaseNotes.NA
 
+    // Check if the release notes contain only GitHub PR links
+    val pullRequests = relNoteBody
+        .split("\n")
+        .map { it.trim() }
+        .mapNotNull(PullRequestLink::parseOrNull)
+
+    if (pullRequests.isNotEmpty()) return ReleaseNotes.CherryPicks(pullRequests)
+
     val list = mutableListOf<ChangelogEntry>()
     var section: String? = null
     var subsection: String? = null
@@ -381,40 +394,44 @@ fun extractReleaseNotes(body: String?, prNumber: Int, prLink: String): ReleaseNo
  *        JetBrains/compose-multiplatform-core
  */
 fun entriesForRepo(repo: String, firstCommit: String, lastCommit: String): List<ChangelogEntry> {
-    val pulls = (1..5)
+    val pulls = (1..10)
         .flatMap {
             requestJson<Array<GitHubPullEntry>>("https://api.github.com/repos/$repo/pulls?state=closed&per_page=100&page=$it").toList()
         }
 
-    val shaToOriginalPull = pulls.associateBy { it.mergeCommitSha }
+    val shaToPull = pulls.associateBy { it.mergeCommitSha }
     val numberToPull = pulls.associateBy { it.number }
-    val pullToCherryPickPull = pulls.associateWith {
-        it.findCherryPickPullNumber()?.let(numberToPull::get)
-    }
-
-    fun pullOf(sha: String): GitHubPullEntry? {
-        val originalPr = shaToOriginalPull[sha]
-        return pullToCherryPickPull[originalPr] ?: originalPr
-    }
-
-    fun changelogEntriesFor(pullRequest: GitHubPullEntry) = with(pullRequest) {
-        extractReleaseNotes(body, number, htmlUrl)?.entries ?:
-            listOf(ChangelogEntry("- $title", null, null, number, htmlUrl, false))
+    val pullToReleaseNotes = Cache( GitHubPullEntry::extractReleaseNotes)
+
+    // if GitHubPullEntry is a cherry-picks PR (contains a list of links to other PRs), replace it by the original PRs
+    fun List<GitHubPullEntry>.replaceCherryPicks(): List<GitHubPullEntry> = flatMap { pullRequest ->
+        val releaseNotes = pullToReleaseNotes[pullRequest]
+        if (releaseNotes is ReleaseNotes.CherryPicks) {
+            releaseNotes.pullRequests
+                .filter { it.repo == repo }
+                .mapNotNull { numberToPull[it.number] }
+        } else {
+            listOf(pullRequest)
+        }
     }
 
     val repoFolder = githubClone(repo)
 
-    // Commits that exist in [firstCommit] and not identified as cherry-picks.
-    // We identify them via reading a PR description "Cherry-picked from ..."
+    // Commits that exist in [firstCommit] and not identified as cherry-picks by `git log`
+    // We'll try to exclude them via manual links to cherry-picks
     val cherryPickedPrsInFirstCommit = gitLogShas(repoFolder, firstCommit, lastCommit, "--cherry-pick --left-only")
-        .mapNotNull(::pullOf)
+        .mapNotNull(shaToPull::get)
+        .replaceCherryPicks()
 
     return gitLogShas(repoFolder, firstCommit, lastCommit, "--cherry-pick --right-only")
         .reversed() // older changes are at the bottom
-        .mapNotNull(::pullOf)
+        .mapNotNull(shaToPull::get)
+        .replaceCherryPicks()
         .minus(cherryPickedPrsInFirstCommit)
         .distinctBy { it.number }
-        .flatMap(::changelogEntriesFor)
+        .flatMap {
+            pullToReleaseNotes[it]?.entries ?: it.unknownChangelogEntries()
+        }
 }
 
 /**
@@ -443,7 +460,11 @@ fun androidxLibToRedirectionVersion(commit: String): Map<String, String> {
 fun androidxLibToVersion(commit: String): Map<String, String> {
     val repo = "ssh://[email protected]/ui/compose-teamcity-config.git"
     val file = ".teamcity/compose/Library.kt"
-    val libraryKt = spaceContentOf(repo, file, commit)
+    val libraryKt = try {
+        spaceContentOf(repo, file, commit)
+    } catch (_: Exception) {
+        ""
+    }
 
     return if (libraryKt.isBlank()) {
         println("Can't find library versions in $repo for $commit. Either the format is changed, or you need to register your ssh key in https://jetbrains.team/m/me/authentication?tab=GitKeys")
@@ -490,18 +511,34 @@ fun githubClone(repo: String): File {
         pipeProcess("git clone --bare $url $absolutePath").waitAndCheck()
     } else {
         println("Fetching $url into ${folder.absolutePath}")
-        pipeProcess("git -C $absolutePath fetch").waitAndCheck()
+        pipeProcess("git -C $absolutePath fetch --tags").waitAndCheck()
     }
     return folder
 }
 
+data class PullRequestLink(val repo: String, val number: Int) {
+    companion object {
+        fun parseOrNull(link: String): PullRequestLink? {
+            val (repo, number) = Regex("https://github\\.com/(.+)/pull/(\\d+)/?")
+                .matchEntire(link)
+                ?.destructured
+                ?: return null
+            return PullRequestLink(repo, number.toInt())
+        }
+    }
+}
+
 sealed interface ReleaseNotes {
     val entries: List<ChangelogEntry>
 
     object NA: ReleaseNotes {
         override val entries: List<ChangelogEntry> get() = emptyList()
     }
 
+    class CherryPicks(val pullRequests: List<PullRequestLink>): ReleaseNotes {
+        override val entries: List<ChangelogEntry> get() = emptyList()
+    }
+
     class Specified(override val entries: List<ChangelogEntry>): ReleaseNotes
 }
 
@@ -530,32 +567,6 @@ data class GitHubPullEntry(
     @SerializedName("merge_commit_sha") val mergeCommitSha: String?,
 )
 
-/**
- * Find a link to the original Pull request:
- * - to show the original PR instead of cherry-pick to users
- *   (and the cherry-pick PR can be found in the comments, GitHub mentions all the links)
- * - to distinguish in case the diff is changed
- *
- * The link should be in format "Cherry-picked from <link>"
- */
-fun GitHubPullEntry.findCherryPickPullNumber(): Int? = body
-    ?.lowercase()
-    ?.split("\n")
-    ?.map { it.trim() }
-    ?.find { it.startsWithAny("cherry-pick", "cherrypick", "cherry pick") }
-    ?.let {
-        val numberFromLink = it
-            .substringAfter("http", "")
-            .substringAfter("/pull/", "")
-            .substringBefore(" ")
-            .toIntOrNull()
-        val numberFromId = it
-            .substringAfter("#", "")
-            .substringBefore(" ")
-            .toIntOrNull()
-        numberFromLink ?: numberFromId
-    }
-
 //region ========================================== UTILS =========================================
 fun pipeProcess(command: String) = ProcessBuilder(command.split(" "))
     .redirectOutput(Redirect.PIPE)
@@ -578,7 +589,11 @@ fun Process.waitAndCheck() {
     }
 }
 
-fun Process.readText(): String = inputStream.bufferedReader().use { it.readText() }
+fun Process.readText(): String = inputStream.bufferedReader().use {
+    it.readText().also {
+        waitAndCheck()
+    }
+}
 
 inline fun <reified T> requestJson(url: String): T =
     Gson().fromJson(requestPlain(url), T::class.java)
@@ -588,7 +603,7 @@ fun requestPlain(url: String): String = exponentialRetry {
     val connection = URL(url).openConnection()
     connection.setRequestProperty("User-Agent", "Compose-Multiplatform-Script")
     if (token != null) {
-        connection.setRequestProperty("Authorization", if (token.startsWith("github_pat")) token else "Bearer $token")
+        connection.setRequestProperty("Authorization", "Bearer $token")
     }
     connection.getInputStream().use {
         it.bufferedReader().readText()
@@ -613,4 +628,9 @@ fun <T> exponentialRetry(block: () -> T): T {
 
 fun String.startsWithAny(vararg prefixes: String): Boolean = prefixes.any { startsWith(it) }
 
+class Cache<K, V>(private val create: (K) -> V) {
+    private val map = mutableMapOf<K,V>()
+    operator fun get(key: K): V = map.getOrPut(key) { create(key) }
+}
+
 //endregion