Set up dokka and publishing

Author: bencehornak

buildSrc/build.gradle.kts

@@ -0,0 +1,19 @@
+plugins {
+    `kotlin-dsl`
+}
+
+dependencies {
+    implementation(plugin(libs.plugins.binary.compatibility.validator))
+    implementation(plugin(libs.plugins.ktlint))
+    implementation(plugin(libs.plugins.kotlin.multiplatform))
+    implementation(plugin(libs.plugins.dokka))
+    implementation(plugin(libs.plugins.vanniktech.maven.publish))
+}
+
+/**
+ * Helper function that transforms a Gradle Plugin alias from a Version Catalog into a valid
+ * dependency notation for buildSrc. Taken from
+ * https://docs.gradle.org/current/userguide/version_catalogs.html#sec:buildsrc-version-catalog
+ */
+private fun DependencyHandlerScope.plugin(plugin: Provider<PluginDependency>) =
+    plugin.map { "${it.pluginId}:${it.pluginId}.gradle.plugin:${it.version}" }

buildSrc/gradle.properties

@@ -0,0 +1,4 @@
+# Enable the v2 syntax of the Dokka Gradle Plugin
+# https://kotlinlang.org/docs/dokka-migration.html
+org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
+org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true

buildSrc/settings.gradle.kts

@@ -0,0 +1,22 @@
+pluginManagement {
+    repositories {
+        google()
+        mavenCentral()
+        gradlePluginPortal()
+    }
+}
+
+dependencyResolutionManagement {
+    repositories {
+        google()
+        mavenLocal()
+        mavenCentral()
+        gradlePluginPortal()
+    }
+
+    versionCatalogs {
+        create("libs") {
+            from(files("../gradle/libs.versions.toml"))
+        }
+    }
+}

buildSrc/src/main/kotlin/dev.openfeature.provider-conventions.gradle.kts

@@ -0,0 +1,90 @@
+import com.vanniktech.maven.publish.JavadocJar
+import com.vanniktech.maven.publish.KotlinMultiplatform
+
+plugins {
+    id("org.jetbrains.kotlin.multiplatform")
+    id("org.jetbrains.kotlinx.binary-compatibility-validator")
+    id("org.jlleitschuh.gradle.ktlint")
+    id("com.vanniktech.maven.publish")
+    id("org.jetbrains.dokka")
+}
+
+// Configure Dokka for documentation
+dokka {
+    dokkaPublications.html {
+        suppressInheritedMembers.set(true)
+        failOnWarning.set(true)
+    }
+    dokkaSourceSets.commonMain {
+        sourceLink {
+            localDirectory.set(file("src/"))
+            remoteUrl("https://github.com/open-feature/kotlin-sdk/tree/main/kotlin-sdk/src")
+            remoteLineSuffix.set("#L")
+        }
+    }
+}
+
+mavenPublishing {
+    configure(
+        KotlinMultiplatform(
+            javadocJar = JavadocJar.Dokka("dokkaGeneratePublicationHtml"),
+            sourcesJar = true,
+            androidVariantsToPublish = listOf("release")
+        )
+    )
+    signAllPublications()
+    coordinates(
+        groupId = "dev.openfeature.kotlin.contrib.providers",
+        version = findProperty("version").toString()
+    )
+    pom {
+        name.set("OpenFeature Kotlin SDK")
+        description.set(
+            "This is the Kotlin implementation of OpenFeature, a vendor-agnostic abstraction library for evaluating feature flags."
+        )
+        url.set("https://openfeature.dev")
+        licenses {
+            license {
+                name.set("The Apache License, Version 2.0")
+                url.set("http://www.apache.org/licenses/LICENSE-2.0.txt")
+            }
+        }
+        developers {
+            developer {
+                id.set("vahidlazio")
+                name.set("Vahid Torkaman")
+                email.set("[email protected]")
+            }
+            developer {
+                id.set("fabriziodemaria")
+                name.set("Fabrizio Demaria")
+                email.set("[email protected]")
+            }
+            developer {
+                id.set("nicklasl")
+                name.set("Nicklas Lundin")
+                email.set("[email protected]")
+            }
+            developer {
+                id.set("nickybondarenko")
+                name.set("Nicky Bondarenko")
+                email.set("[email protected]")
+            }
+            developer {
+                id.set("bencehornak")
+                name.set("Bence Hornák")
+                email.set("[email protected]")
+            }
+        }
+        scm {
+            connection.set(
+                "scm:git:https://github.com/open-feature/kotlin-sdk-contrib.git"
+            )
+            developerConnection.set(
+                "scm:git:ssh://open-feature/kotlin-sdk-contrib.git"
+            )
+            url.set("https://github.com/open-feature/kotlin-sdk-contrib")
+        }
+    }
+}
+

gradle.properties

@@ -1,6 +1,12 @@
+version=0.1.0
 org.gradle.configuration-cache=true
 
 # This seems to be necessary for Coroutines to work on JS. Otherwise getting the following error:
 #   > Task :providers:env-var:compileTestDevelopmentExecutableKotlinJs FAILED
 #   e: java.lang.IllegalStateException: IC internal error: can not find library org.jetbrains.kotlin:kotlinx-atomicfu-runtime
-kotlinx.atomicfu.enableJsIrTransformation=true
+kotlinx.atomicfu.enableJsIrTransformation=true
+
+# Enable the v2 syntax of the Dokka Gradle Plugin
+# https://kotlinlang.org/docs/dokka-migration.html
+org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
+org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true

gradle/libs.versions.toml

@@ -10,8 +10,10 @@ kotlinx-coroutines-core = { group="org.jetbrains.kotlinx", name="kotlinx-corouti
 kotlinx-coroutines-test = { group="org.jetbrains.kotlinx", name="kotlinx-coroutines-test", version.ref="kotlinx-coroutines" }
 
 [plugins]
+dokka = { id="org.jetbrains.dokka", version="2.0.0" }
 kotlin-multiplatform = { id="org.jetbrains.kotlin.multiplatform", version.ref="kotlin" }
 kotlinx-atomicfu = { id="org.jetbrains.kotlinx.atomicfu", version="0.27.0" }
 ktlint = { id="org.jlleitschuh.gradle.ktlint", version="12.3.0" }
 nexus-publish = { id="io.github.gradle-nexus.publish-plugin", version="2.0.0" }
-binary-compatibility-validator = { id="org.jetbrains.kotlinx.binary-compatibility-validator", version="0.17.0" }
+binary-compatibility-validator = { id="org.jetbrains.kotlinx.binary-compatibility-validator", version="0.17.0" }
+vanniktech-maven-publish = { id="com.vanniktech.maven.publish", version="0.34.0" }

providers/env-var/build.gradle.kts

@@ -3,9 +3,7 @@ import org.jetbrains.kotlin.gradle.targets.js.testing.KotlinJsTest
 import org.jetbrains.kotlin.gradle.targets.native.tasks.KotlinNativeTest
 
 plugins {
-    alias(libs.plugins.kotlin.multiplatform)
-    alias(libs.plugins.binary.compatibility.validator)
-    alias(libs.plugins.ktlint)
+    id("dev.openfeature.provider-conventions")
     // Needed for the JS coroutine support for the tests
     alias(libs.plugins.kotlinx.atomicfu)
 }