Improve and automate changelog generation (#1872)

* improve and automate changelog generation
mobile-dev-inc · Aug 2, 2024 · 702b184 · 702b184
1 parent 48c5120
commit 702b184
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,14 +1,20 @@
 # Changelog
 
-## 1.37.5 - 2024-08-02
+## 1.37.5
+
+Released on 2024-08-02
 
 - Fix cryptic "SocketException" when API token is invalid ([#1871](https://github.com/mobile-dev-inc/maestro/pull/1871))
 
-## 1.37.4 - 2024-07-30
+## 1.37.4
+
+Released on 2024-07-30
 
 - Don't ask for analytics permission on CI + add `MAESTRO_CLI_NO_ANALYTICS` env var ([#1848](https://github.com/mobile-dev-inc/maestro/pull/1848))
 
-## 1.37.3 - 2024-07-29
+## 1.37.3
+
+Released on 2024-07-29
 
 ### Bug fixes
 

diff --git a/maestro-cli/build.gradle.kts b/maestro-cli/build.gradle.kts
@@ -115,14 +115,26 @@ jreleaser {
             artifact {
                 setPath("build/distributions/maestro.zip")
             }
-            
+
             release {
                 github {
                     repoOwner.set("mobile-dev-inc")
                     name.set("maestro")
                     tagName.set("cli-$CLI_VERSION")
                     releaseName.set("CLI $CLI_VERSION")
                     overwrite.set(true)
+
+                    changelog {
+                        // GitHub removes dots Markdown headers (1.37.5 becomes 1375)
+                        extraProperties.put("versionHeader", CLI_VERSION.replace(".", ""))
+
+                        content.set("""
+                            [See changelog in the CHANGELOG.md file][link]
+
+                            [link]: https://github.com/mobile-dev-inc/maestro/blob/main/CHANGELOG.md#{{versionHeader}}
+                        """.trimIndent()
+                        )
+                    }
                 }
             }
         }