Changelog Github action

Author: igordmn

.github/PULL_REQUEST_TEMPLATE.md

@@ -14,33 +14,4 @@ Describe how you tested your changes. If possible and needed:
 This should be tested by QA
 
 ## Release Notes
-<!--
-If we definitely shouldn't add Release Notes, add only N/A.
-
-Or enumerate sections, subsections and all changes.
-
-Possible sections:
-- Highlights             // major features
-- Known Issues           // issues planned to be fixed, with possible workarounds
-- Breaking Changes       // incompatible changes without deprecation cycle
-- Migration Notes        // deprecations, removals, minimal version increases, defined behavior changes
-- Features               // minor features
-- Fixes                  // bug fixes, undefined behavior changes
-
-Possible subsections:
-- Multiple Platforms     // any module, 2 or more platform changes
-- iOS                    // any module, iOS-only changes
-- Desktop                // any module, Desktop-only changes
-- Web                    // any module, Web-only changes
-- Android                // any module, Android-only changes
-- Resources              // specific module, prefer it over the platform ones
-- Gradle Plugin          // specific module, prefer it over the platform ones
-- Lifecycle              // specific module, prefer it over the platform ones
-- Navigation             // specific module, prefer it over the platform ones
--->
-### Section - Subsection
-- Describe a change for adding it to https://github.com/JetBrains/compose-multiplatform/blob/master/CHANGELOG.md
-- _(prerelease fix)_ Fix some bug that introduced in a prerelease version (alpha/beta/rc). It will be included in a alpha/beta/rc changelog, but excluded from a stable changelog
-
-### Section - Subsection
-- Describe another change if needed
+See the format in https://github.com/JetBrains/compose-multiplatform/blob/master/tools/changelog/PR_FORMAT.md

.github/workflows/check-release-notes.yml

@@ -0,0 +1,21 @@
+# Checks Release Notes in the PR description, runs when:
+#   opened - PR is opened
+#   edited - The title/description are changed
+#   synchronize - New commits appeared.
+#                 We don't use the new content, but we still need to mark this commit Green/Red in GitHub UI
+
+name: Check Release Notes in the description
+on:
+  pull_request:
+    types: [opened, edited, synchronize]
+
+jobs:
+  check:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          sparse-checkout: 'tools/changelog/check-release-notes-github-action'
+      - uses: ./tools/changelog/check-release-notes-github-action
+        with:
+          checkout_ref: ${{ github.ref }}

tools/changelog/PR_FORMAT.md

@@ -0,0 +1,75 @@
+Each Pull Request should contain "## Release Notes" section that describes changes in this PR.
+
+Each release, changes from all PRs are combined into a list and added to CHANGELOG.md
+(by [changelog.main.kts](changelog.main.kts) script).
+
+## Possible Release Notes
+
+### No Release Notes
+```
+## Release Notes
+N/A
+```
+
+### Simple Change
+```
+## Release Notes
+### Highlights - iOS
+- Describe a change
+```
+
+### Simple Change with Details
+```
+## Release Notes
+### Highlights - iOS
+- Describe a change
+  - Describe details 1
+  - Describe details 2
+```
+
+### Multiple Changes
+```
+## Release Notes
+### Features - Desktop
+- Describe change 1
+  - Describe details
+- Describe change 2
+
+### Fixes - Web
+- Describe change 3
+```
+
+### Prerelease Fix
+Will be includede 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
+```
+
+## Possible Sections
+
+### Sections
+<!-- This is parsed by changelog.main.kts -->
+```
+- Highlights             # major features
+- Known Issues           # issues planned to be fixed, with possible workarounds
+- Breaking Changes       # incompatible changes without deprecation cycle
+- Migration Notes        # deprecations, removals, minimal version increases, defined behavior changes
+- Features               # minor features
+- Fixes                  # bug fixes, undefined behavior changes
+```
+
+### Subsections
+<!-- This is parsed by changelog.main.kts -->
+```
+- Multiple Platforms     # any module, 2 or more platform changes
+- iOS                    # any module, iOS-only changes
+- Desktop                # any module, Desktop-only changes
+- Web                    # any module, Web-only changes
+- Android                # any module, Android-only changes
+- Resources              # specific module, prefer it over the platform ones
+- Gradle Plugin          # specific module, prefer it over the platform ones
+- Lifecycle              # specific module, prefer it over the platform ones
+- Navigation             # specific module, prefer it over the platform ones
+```

tools/changelog.main.kts tools/changelog/changelog.main.ktstools/changelog.main.kts renamed to tools/changelog/changelog.main.kts

@@ -15,9 +15,11 @@
  *
  * Changelog entries are generated from reading Release Notes in GitHub PR's.
  *
- * ## Checking PRs
+ * ## Checking PR description in a file
+ * Not supposed to be called manually, used by GitHub workflow:
+ * https://github.com/JetBrains/compose-multiplatform/blob/master/tools/changelog/check-release-notes-github-action/action.yml)
  * ```
- * kotlin changelog.main.kts action=checkPr compose-multiplatform 5202
+ * kotlin changelog.main.kts action=checkPr prDescription.txt
  * ```
  *
  * compose-multiplatform - name of the GitHub repo
@@ -41,8 +43,10 @@
 
 import com.google.gson.Gson
 import com.google.gson.annotations.SerializedName
+import java.io.File
 import java.io.IOException
 import java.lang.ProcessBuilder.Redirect
+import java.lang.System.err
 import java.net.URL
 import java.net.URLEncoder
 import java.nio.charset.StandardCharsets.UTF_8
@@ -51,35 +55,9 @@ import java.time.format.DateTimeFormatter
 import java.util.*
 import kotlin.system.exitProcess
 
-//region ========================================== CONSTANTS =========================================
-
-// Sections from the template https://github.com/JetBrains/compose-multiplatform/blob/master/.github/PULL_REQUEST_TEMPLATE.md?plain=1
-// Changelog should contain only these categories
-
-val standardSections = listOf(
-    "Highlights",
-    "Known Issues",
-    "Breaking Changes",
-    "Migration Notes",
-    "Features",
-    "Fixes",
-)
-
-val standardSubsections = listOf(
-    "Multiple Platforms",
-    "iOS",
-    "Desktop",
-    "Web",
-    "Android",
-    "Resources",
-    "Gradle Plugin",
-    "Lifecycle",
-    "Navigation",
-)
-
 val changelogFile = __FILE__.resolve("../../CHANGELOG.md").canonicalFile
-
-//endregion
+val prFormatFile = File("PR_FORMAT.md")
+val prFormatLink = "https://github.com/JetBrains/compose-multiplatform/blob/master/tools/changelog/PR_FORMAT.md"
 
 val argsKeyless = args
     .filter { !it.contains("=") }
@@ -89,9 +67,19 @@ val argsKeyToValue = args
     .associate { it.substringBefore("=") to it.substringAfter("=") }
 
 val token = argsKeyToValue["token"]
-if (token == null) {
-    println("To increase the rate limit, specify token (https://github.com/settings/tokens), adding token=yourtoken in the end")
-}
+
+// Parse sections from [PR_FORMAT.md]
+fun parseSections(title: String) = prFormatFile
+    .readText()
+    .substringAfter(title)
+    .substringAfter("```")
+    .substringBefore("```")
+    .split("\n")
+    .map { it.trim().removePrefix("-").substringBefore("#").substringBefore("\n").trim() }
+    .filter { it.isNotEmpty() }
+
+val standardSections = parseSections("### Sections")
+val standardSubsections = parseSections("### Subsections")
 
 println()
 
@@ -101,6 +89,10 @@ when (argsKeyToValue["action"]) {
 }
 
 fun generateChangelog() {
+    if (token == null) {
+        println("To increase the rate limit, specify token (https://github.com/settings/tokens), adding token=yourtoken in the end")
+    }
+
     val commitsArg = argsKeyless.getOrNull(0) ?: "HEAD"
 
     var previousVersionCommitArg: String?
@@ -253,55 +245,42 @@ fun generateChangelog() {
 }
 
 fun checkPr() {
-    val repo = argsKeyless.getOrNull(0) ?: error("Please specify PR number as the first argument")
-    val prNumber = argsKeyless.getOrNull(1) ?: error("Please specify PR number as the second argument")
-    val releaseNotes = pullRequest(repo, prNumber).extractReleaseNotes()
+    val filePath = argsKeyless.getOrNull(0) ?: error("Please specify a file that contains PR description as the first argument")
 
-    val commonDescription = """
-            Valid examples:
-            
-            ## Release Notes
-            ### Features - Desktop
-            - Added Drag&Drop support
-            - Fixed non-working Drag&Drop in dialogs
-            
-            ### Features - iOS
-            - Added Drag&Drop support
+    val body = File(filePath).readText()
+    val releaseNotes = extractReleaseNotes(body, 0, "https://github.com/JetBrains/compose-multiplatform/pull/0")
 
-            ## Release Notes
-            N/A
-            
-            Allowed sections: ${standardSections.joinToString(", ")}
-            Allowed subsections: ${standardSubsections.joinToString(", ")}
-    """.trimIndent()
-
-    val nonstandardSections = if (releaseNotes is ReleaseNotes.Specified) {
-        releaseNotes.entries
-            .filter { it.section !in standardSections || it.subsection !in standardSubsections }
-            .map { "${it.section} - ${it.subsection}" }
-            .toSet()
-    } else {
-        emptySet()
-    }
+    val nonstandardSections = releaseNotes?.entries
+        .orEmpty()
+        .filter { it.section !in standardSections || it.subsection !in standardSubsections }
+        .map { "${it.section} - ${it.subsection}" }
+        .toSet()
+
+    println()
 
     when {
-        releaseNotes == null -> {
-            System.err.println("""
-                    "## Release Notes" section is missing in the PR description
-                    
-                    
-                """.trimIndent() + commonDescription)
+        releaseNotes is ReleaseNotes.Specified && releaseNotes.entries.isEmpty() -> {
+            err.println("\"## Release Notes\" doesn't contain any items, or section isn't specified")
+            err.println()
+            err.println("See the format in $prFormatLink")
+            exitProcess(1)
+        }
+        releaseNotes is ReleaseNotes.Specified && nonstandardSections.isNotEmpty() -> {
+            err.println("\"## Release Notes\" contains nonstandard sections:")
+            err.println(nonstandardSections.joinToString(", "))
+            err.println()
+            err.println("See possible sections in $prFormatLink#possible-sections")
             exitProcess(1)
         }
-        nonstandardSections.isNotEmpty() -> {
-            System.err.println("""
-                    "## Release Notes" contains nonstandard sections:
-                    ${nonstandardSections.joinToString(", ")}
-                    
-                    
-                """.trimIndent() + commonDescription)
+        releaseNotes == null -> {
+            err.println("\"## Release Notes\" section is missing in the PR description")
+            err.println()
+            err.println("See the format in $prFormatLink")
             exitProcess(1)
         }
+        else -> {
+            println("\"## Release Notes\" are correct")
+        }
     }
 }
 
@@ -311,9 +290,9 @@ fun checkPr() {
 fun currentChangelogDate() = LocalDate.now().format(DateTimeFormatter.ofPattern("MMMM yyyy", Locale.ENGLISH))
 
 /**
- * Extract by format https://github.com/JetBrains/compose-multiplatform/blob/master/.github/PULL_REQUEST_TEMPLATE.md?plain=1
+ * Extract by format [PR_FORMAT.md]
  */
-fun GitHubPullEntry.extractReleaseNotes(): ReleaseNotes? {
+fun extractReleaseNotes(body: String?, prNumber: Int, prLink: String): ReleaseNotes? {
     fun String?.substringBetween(begin: String, end: String): String? {
         val after = this?.substringAfter(begin, "")?.ifBlank { null }
         return after?.substringBefore(end, "")?.ifBlank { null } ?: after
@@ -369,8 +348,8 @@ fun GitHubPullEntry.extractReleaseNotes(): ReleaseNotes? {
                     lineFixed,
                     section,
                     subsection,
-                    number,
-                    htmlUrl.takeIf { isTopLevel }
+                    prNumber,
+                    prLink.takeIf { isTopLevel }
                 )
             )
             isFirstLine = false
@@ -396,8 +375,10 @@ fun entriesForRepo(repo: String, firstCommit: String, lastCommit: String): List<
         pullRequest: GitHubPullEntry?
     ): List<ChangelogEntry> {
         return if (pullRequest != null) {
-            pullRequest.extractReleaseNotes()?.entries ?:
-                listOf(ChangelogEntry("- ${pullRequest.title}", null, null, pullRequest.number, pullRequest.htmlUrl))
+            with(pullRequest) {
+                extractReleaseNotes(body, number, htmlUrl)?.entries ?:
+                    listOf(ChangelogEntry("- $title", null, null, number, htmlUrl))
+            }
         } else {
             listOf()
         }

tools/changelog/check-release-notes-github-action/action.yml

@@ -0,0 +1,26 @@
+# Reusable GitHub action needed to check Release Notes in the PR description. Used by multiple Compose repositories.
+
+name: Check Release Notes in the description
+
+inputs:
+  checkout_ref:
+    type: string
+    default: 'master'
+
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/checkout@v4
+      with:
+        repository: JetBrains/compose-multiplatform
+        ref: ${{ inputs.checkout_ref }}
+        sparse-checkout: 'tools/changelog'
+    - name: Check Release Notes in the description
+      shell: bash
+      env:
+        # To avoid injections as suggested in https://docs.github.com/en/actions/security-for-github-actions/security-guides/security-hardening-for-github-actions#using-an-intermediate-environment-variable
+        PR_DESCRIPTION: ${{ github.event.pull_request.body }}
+      run: |
+        cd tools/changelog
+        echo "$PR_DESCRIPTION" > prDescription.txt
+        kotlin changelog.main.kts action=checkPr prDescription.txt token=""