chore: fix dokka issues execution oom

.github/workflows/generate-dokka.yml

@@ -4,6 +4,9 @@ on:
     push:
         branches:
             - develop # later on we should stick to main, since there will be the releases
+    # remove this after testing on ci
+    pull_request: # remove this after testing on ci
+        types: [ opened, edited, synchronize ]
 
 jobs:
     publish:

build.gradle.kts

@@ -32,7 +32,6 @@ buildscript {
         classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:${libs.versions.kotlin.get()}")
         classpath("app.cash.sqldelight:gradle-plugin:${libs.versions.sqldelight.get()}")
         classpath("com.wire:carthage-gradle-plugin:${libs.versions.carthage.get()}")
-        classpath("org.jetbrains.dokka:dokka-gradle-plugin:${libs.versions.dokka.get()}")
         classpath("com.google.protobuf:protobuf-gradle-plugin:${libs.versions.protobufCodegen.get()}")
         classpath("io.gitlab.arturbosch.detekt:detekt-gradle-plugin:${libs.versions.detekt.get()}")
         classpath("io.gitlab.arturbosch.detekt:detekt-cli:${libs.versions.detekt.get()}")
@@ -118,5 +117,3 @@ kover {
 rootProject.plugins.withType<org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootPlugin> {
     rootProject.the<org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootExtension>().nodeVersion = "17.6.0"
 }
-
-tasks.dokkaHtmlMultiModule.configure {}

buildSrc/src/main/kotlin/com/wire/kalium/plugins/CommonDokkaConfig.kt

@@ -28,9 +28,7 @@ val documentedSubprojects = listOf(
     "cryptography",
     "logger",
     "logic",
-    "network",
     "persistence",
-    "protobuf"
 )
 
 /**
@@ -50,7 +48,7 @@ fun Project.commonDokkaConfig() {
                 includes.from(it)
             }
             includes.from(rootProject.file("dokka/moduledoc.md").path)
-            samples.from(rootProject.file("samples"))
+            // samples.from(rootProject.file("samples")) // Disabling samples for dokka to avoid OOM
             includeNonPublic.set(true)
             documentedVisibilities.set(listOf(Visibility.PUBLIC, Visibility.INTERNAL))
         }

cli/src/commonMain/kotlin/com/wire/kalium/cli/commands/ListenGroupCommand.kt

@@ -48,7 +48,7 @@ class ListenGroupCommand : CliktCommand(name = "listen-group") {
         }
 
         while (true) {
-            val message = readLine()!!
+            val message = readln()
             userSession.messages.sendTextMessage(conversationID, message)
         }
     }

gradle.properties

@@ -16,11 +16,14 @@
 # along with this program. If not, see http://www.gnu.org/licenses/.
 #
 
-org.gradle.jvmargs=-Xmx2g -XX:+UseParallelGC
+# Increase MaxMetaspaceSize for dokka to avoid OOM
+org.gradle.jvmargs=-Xmx4g -XX:+UseParallelGC -XX:MaxMetaspaceSize=2G
 android.useAndroidX=true
 kotlin.native.binary.memoryModel=experimental
 kotlin.js.generate.executable.default=false
 kotlin.js.compiler=ir
 kotlin.native.binary.freezing=disabled
 
 org.gradle.parallel=true
+# Needed for dokka multimodule linking
+kotlin.mpp.enableCompatibilityMetadataVariant=true

network/build.gradle.kts

@@ -35,8 +35,8 @@ kotlin {
         val commonMain by getting {
             dependencies {
                 implementation(project(":protobuf"))
-                implementation(project(":util"))
                 api(project(":logger"))
+                implementation(project(":util"))
 
                 // coroutines
                 implementation(libs.coroutines.core)

scripts/release.mk

@@ -1,4 +1,4 @@
 # release related targets, ie: docs, changelog, build aar, etc.
 # dokka
 doc/generate-kdocs:
-	./gradlew dokkaHtmlMultiModule
+	./gradlew -Dorg.gradle.jvmargs=-Xmx8g --stacktrace dokkaHtmlMultiModule