feat: Configure publishing for compose multiplatform artifacts (#2162)

Author: romtsn

.craft.yml

@@ -43,3 +43,5 @@ targets:
       maven:io.sentry:sentry-graphql:
       maven:io.sentry:sentry-android-navigation:
       maven:io.sentry:sentry-compose:
+      maven:io.sentry:sentry-compose-android:
+      maven:io.sentry:sentry-compose-desktop:

Makefile

@@ -1,6 +1,6 @@
-.PHONY: all clean compile dryRelease update stop checkFormat format api assembleBenchmarkTestRelease assembleUiTestRelease
+.PHONY: all clean compile javadocs dryRelease update stop checkFormat format api assembleBenchmarkTestRelease assembleUiTestRelease
 
-all: stop clean checkFormat compile dryRelease
+all: stop clean javadocs compile
 assembleBenchmarks: stop clean assembleBenchmarkTestRelease
 assembleUiTests: stop clean assembleUiTestRelease
 
@@ -13,6 +13,9 @@ clean:
 compile:
 	./gradlew build
 
+javadocs:
+	./gradlew aggregateJavadocs
+
 # do a dry release (like a local deploy)
 dryRelease:
 	./gradlew aggregateJavadocs publishToMavenLocal --no-daemon --no-parallel

build.gradle.kts

@@ -104,13 +104,17 @@ subprojects {
         val sep = File.separator
 
         configure<DistributionContainer> {
-            this.getByName("main").contents {
-                // non android modules
-                from("build${sep}libs")
-                from("build${sep}publications${sep}maven")
-                // android modules
-                from("build${sep}outputs${sep}aar")
-                from("build${sep}publications${sep}release")
+            if (this@subprojects.name.contains("-compose")) {
+                this.configureForMultiplatform(this@subprojects)
+            } else {
+                this.getByName("main").contents {
+                    // non android modules
+                    from("build${sep}libs")
+                    from("build${sep}publications${sep}maven")
+                    // android modules
+                    from("build${sep}outputs${sep}aar")
+                    from("build${sep}publications${sep}release")
+                }
             }
         }
 

buildSrc/src/main/java/Config.kt

@@ -21,6 +21,7 @@ object Config {
         val grettyVersion = "4.0.0"
         val gradleMavenPublishPlugin = "com.vanniktech:gradle-maven-publish-plugin:0.18.0"
         val dokkaPlugin = "org.jetbrains.dokka:dokka-gradle-plugin:$kotlinVersion"
+        val dokkaPluginAlias = "org.jetbrains.dokka"
         val composeGradlePlugin = "org.jetbrains.compose:compose-gradle-plugin:$composeVersion"
     }
 

buildSrc/src/main/java/Publication.kt

@@ -0,0 +1,63 @@
+import org.gradle.api.Project
+import org.gradle.api.distribution.DistributionContainer
+import org.gradle.api.file.CopySpec
+import java.io.File
+
+private object Consts {
+    val taskRegex = Regex("(.*)DistZip")
+}
+
+// configure distZip tasks for multiplatform
+fun DistributionContainer.configureForMultiplatform(project: Project) {
+    val sep = File.separator
+
+    this.maybeCreate("android").contents {
+        from("build${sep}publications${sep}androidRelease")
+        from("build${sep}outputs${sep}aar") {
+            rename {
+                it.replace("-release", "-android-${project.version}")
+            }
+        }
+        from("build${sep}libs") {
+            include("*android*")
+            withJavadoc(renameTo = "compose-android")
+        }
+    }
+    this.getByName("main").contents {
+        from("build${sep}publications${sep}kotlinMultiplatform")
+        from("build${sep}kotlinToolingMetadata")
+        from("build${sep}libs") {
+            include("*compose-kotlin*")
+            rename {
+                it.replace("-kotlin", "")
+            }
+            withJavadoc()
+        }
+    }
+    this.maybeCreate("desktop").contents {
+        // kotlin multiplatform modules
+        from("build${sep}publications${sep}desktop")
+        from("build${sep}libs") {
+            include("*desktop*")
+            withJavadoc(renameTo = "compose-desktop")
+        }
+    }
+
+    // make other distZip tasks run together with the main distZip
+    project.tasks.getByName("distZip").dependsOn(
+        *project.tasks.filter { task ->
+            task.name.matches(Consts.taskRegex)
+        }.toTypedArray()
+    )
+}
+
+private fun CopySpec.withJavadoc(renameTo: String = "compose") {
+    include("*javadoc*")
+    rename {
+        if (it.contains("javadoc")) {
+            it.replace("compose", renameTo)
+        } else {
+            it
+        }
+    }
+}

sentry-compose/build.gradle.kts

@@ -1,4 +1,5 @@
 import io.gitlab.arturbosch.detekt.Detekt
+import org.jetbrains.dokka.gradle.DokkaTask
 
 plugins {
     kotlin("multiplatform")
@@ -7,6 +8,7 @@ plugins {
     jacoco
     id(Config.QualityPlugins.gradleVersions)
     id(Config.QualityPlugins.detektPlugin)
+    id(Config.BuildPlugins.dokkaPluginAlias)
     `maven-publish` // necessary for publishMavenLocal task to publish correct artifacts
 }
 
@@ -113,3 +115,15 @@ tasks.withType<Detekt> {
     // Target version of the generated JVM bytecode. It is used for type resolution.
     jvmTarget = JavaVersion.VERSION_1_8.toString()
 }
+
+tasks.withType<DokkaTask>().configureEach {
+    // suppress unattached source sets for docs
+    dokkaSourceSets {
+        matching {
+            it.name.contains("androidandroid", ignoreCase = true) ||
+                it.name.contains("testfixtures", ignoreCase = true)
+        }.configureEach {
+            suppress.set(true)
+        }
+    }
+}