Configure publishing through convention plugins and migrate to new workflow (#40)

Author: gpunto

.github/workflows/publish-new-version.yml

@@ -4,12 +4,18 @@ on:
   workflow_dispatch:
     inputs:
       bump:
+        required: true
         type: choice
         description: "Type of version bump to perform"
         options:
           - patch
           - minor
           - major
+        default: minor
+
+concurrency:
+  group: release
+  cancel-in-progress: false
 
 jobs:
   pre_release_check:
@@ -21,20 +27,17 @@ jobs:
         id: pre_release_check_step
         run: echo "Pre release check"
   publish:
+    permissions:
+      contents: write
     needs: pre_release_check
-    uses: GetStream/android-ci-actions/.github/workflows/release-new-version.yml@main
+    uses: GetStream/stream-build-conventions-android/blob/develop/.github/workflows/[email protected]
+
     with:
-      ref: "develop"
       bump: ${{ inputs.bump }}
-      file-path: ./buildSrc/src/main/kotlin/io/getstream/core/Configuration.kt
-      excluded-modules: "app"
-      use-official-plugin: false
-      # Disable explicit documentation tasks as they are already included while publishing
-      documentation-tasks: tasks
     secrets:
-      OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
-      OSSRH_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
-      SIGNING_KEY_ID: ${{ secrets.SIGNING_KEY_ID }}
-      SIGNING_PASSWORD: ${{ secrets.SIGNING_PASSWORD }}
-      SIGNING_KEY: ${{ secrets.SIGNING_KEY }}
-      STREAM_PUBLIC_BOT_TOKEN: ${{ secrets.STREAM_PUBLIC_BOT_TOKEN }}
+      github-token: ${{ secrets.STREAM_PUBLIC_BOT_TOKEN }}
+      maven-central-username: ${{ secrets.OSSRH_USERNAME }}
+      maven-central-password: ${{ secrets.OSSRH_PASSWORD }}
+      signing-key: ${{ secrets.SIGNING_KEY }}
+      signing-key-id: ${{ secrets.SIGNING_KEY_ID }}
+      signing-key-password: ${{ secrets.SIGNING_PASSWORD }}

build.gradle.kts

@@ -1,7 +1,6 @@
 import com.android.build.api.dsl.ApplicationExtension
 import com.android.build.api.dsl.LibraryExtension
 import com.vanniktech.maven.publish.MavenPublishBaseExtension
-import io.getstream.core.Configuration
 
 plugins {
     alias(libs.plugins.stream.project)
@@ -14,8 +13,6 @@ plugins {
     alias(libs.plugins.android.library) apply false
     alias(libs.plugins.kotlin.compose) apply false
     alias(libs.plugins.ksp) apply false
-    alias(libs.plugins.maven.publish)
-    alias(libs.plugins.dokka) apply false
     alias(libs.plugins.arturbosch.detekt) apply true
 }
 
@@ -29,6 +26,10 @@ streamProject {
     coverage {
         includedModules = setOf("stream-android-core")
     }
+
+    publishing {
+        description = "Stream Core official Android SDK"
+    }
 }
 
 detekt {
@@ -38,9 +39,6 @@ detekt {
     buildUponDefaultConfig = true
 }
 
-private val isSnapshot = System.getenv("SNAPSHOT")?.toBoolean() == true
-version = if (isSnapshot) Configuration.snapshotVersionName else Configuration.versionName
-
 subprojects {
     // Configure Android projects with common SDK versions as soon as either plugin is applied
     pluginManager.withPlugin("com.android.library") {
@@ -63,74 +61,3 @@ subprojects {
         }
     }
 }
-
-subprojects {
-    plugins.withId("com.vanniktech.maven.publish") {
-        extensions.configure<MavenPublishBaseExtension> {
-            publishToMavenCentral(automaticRelease = true)
-
-            pom {
-                name.set("Stream Android Core")
-                description.set("Stream Core official Android SDK")
-                url.set("https://github.com/getstream/stream-core-android")
-
-                licenses {
-                    license {
-                        name.set("Stream License")
-                        url.set("https://github.com/GetStream/stream-core-android/blob/main/LICENSE")
-                    }
-                }
-
-                developers {
-                    developer {
-                        id = "aleksandar-apostolov"
-                        name = "Aleksandar Apostolov"
-                        email = "[email protected]"
-                    }
-                    developer {
-                        id = "VelikovPetar"
-                        name = "Petar Velikov"
-                        email = "[email protected]"
-                    }
-                    developer {
-                        id = "andremion"
-                        name = "André Mion"
-                        email = "[email protected]"
-                    }
-                    developer {
-                        id = "rahul-lohra"
-                        name = "Rahul Kumar Lohra"
-                        email = "[email protected]"
-                    }
-                    developer {
-                        id = "gpunto"
-                        name = "Gianmarco David"
-                        email = "[email protected]"
-                    }
-                }
-
-                scm {
-                    connection.set("scm:git:github.com/getstream/stream-core-android.git")
-                    developerConnection.set("scm:git:ssh://github.com/getstream/stream-core-android.git")
-                    url.set("https://github.com/getstream/stream-core-android/tree/main")
-                }
-            }
-        }
-    }
-}
-
-tasks.register("printAllArtifacts") {
-    group = "publishing"
-    description = "Prints all artifacts that will be published"
-
-    doLast {
-        subprojects.forEach { subproject ->
-            subproject.plugins.withId("com.vanniktech.maven.publish") {
-                subproject.extensions.findByType(PublishingExtension::class.java)
-                    ?.publications
-                    ?.filterIsInstance<MavenPublication>()
-                    ?.forEach { println("${it.groupId}:${it.artifactId}:${it.version}") }
-            }
-        }
-    }
-}

buildSrc/build.gradle.kts

@@ -20,4 +20,7 @@ kotlin.code.style=official
 # Enables namespacing of each library's R class so that its R class includes only the
 # resources declared in the library itself and none from the library's dependencies,
 # thereby reducing the size of the R class for that library
-android.nonTransitiveRClass=true
+android.nonTransitiveRClass=true
+
+# Project version
+version=1.1.1

buildSrc/src/main/kotlin/io/getstream/core/Configuration.kt

@@ -26,9 +26,7 @@ retrofit = "3.0.0"
 ksp = "2.2.0-2.0.2"
 robolectric = "4.15.1"
 detekt = "1.23.8"
-streamConventions = "0.4.0"
-mavenPublish = "0.34.0"
-kotlinDokka = "1.9.20"
+streamConventions = "0.5.0"
 annotationJvm = "1.9.1"
 
 [libraries]
@@ -83,5 +81,3 @@ stream-project = { id = "io.getstream.project", version.ref = "streamConventions
 stream-android-library = { id = "io.getstream.android.library", version.ref = "streamConventions" }
 stream-android-application = { id = "io.getstream.android.application", version.ref = "streamConventions" }
 stream-java-library = { id = "io.getstream.java.library", version.ref = "streamConventions" }
-maven-publish = { id = "com.vanniktech.maven.publish", version.ref = "mavenPublish" }
-dokka = { id = "org.jetbrains.dokka", version.ref = "kotlinDokka" }

gradle.properties

@@ -1,24 +1,4 @@
-import com.vanniktech.maven.publish.JavadocJar
-import com.vanniktech.maven.publish.KotlinJvm
-import io.getstream.core.Configuration
-
 plugins {
-    alias(libs.plugins.stream.java.library)
     alias(libs.plugins.jetbrains.kotlin.jvm)
-    alias(libs.plugins.maven.publish)
-    alias(libs.plugins.dokka)
-}
-
-mavenPublishing {
-    coordinates(
-        groupId = Configuration.artifactGroup,
-        artifactId = "stream-android-core-annotations",
-        version = rootProject.version.toString(),
-    )
-    configure(
-        KotlinJvm(
-            javadocJar = JavadocJar.Dokka("dokkaJavadoc"),
-            sourcesJar = true,
-        ),
-    )
+    alias(libs.plugins.stream.java.library)
 }

gradle/libs.versions.toml

@@ -1,11 +1,6 @@
-import com.vanniktech.maven.publish.JavadocJar
-import com.vanniktech.maven.publish.KotlinJvm
-
 plugins {
-    alias(libs.plugins.stream.java.library)
     alias(libs.plugins.jetbrains.kotlin.jvm)
-    alias(libs.plugins.maven.publish)
-    alias(libs.plugins.dokka)
+    alias(libs.plugins.stream.java.library)
 }
 
 dependencies {
@@ -22,17 +17,3 @@ tasks.jar {
         attributes["Lint-Registry-v2"] = "io.getstream.android.core.lint.StreamIssueRegistry"
     }
 }
-
-mavenPublishing {
-    coordinates(
-        groupId = io.getstream.core.Configuration.artifactGroup,
-        artifactId = "stream-android-core-lint",
-        version = rootProject.version.toString(),
-    )
-    configure(
-        KotlinJvm(
-            javadocJar = JavadocJar.Dokka("dokkaJavadoc"),
-            sourcesJar = true,
-        ),
-    )
-}

stream-android-core-annotations/build.gradle.kts

@@ -1,7 +1,5 @@
 @file:OptIn(ExperimentalAbiValidation::class)
 
-import com.vanniktech.maven.publish.AndroidSingleVariantLibrary
-import io.getstream.core.Configuration
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.dsl.abi.ExperimentalAbiValidation
 
@@ -10,7 +8,6 @@ plugins {
     alias(libs.plugins.kotlin.android)
     alias(libs.plugins.ksp)
     alias(libs.plugins.arturbosch.detekt)
-    alias(libs.plugins.maven.publish)
 }
 
 kotlin {
@@ -86,18 +83,3 @@ dependencies {
     testImplementation(libs.kotlinx.coroutines.test)
     testImplementation(libs.mockwebserver)
 }
-
-mavenPublishing {
-    coordinates(
-        groupId = Configuration.artifactGroup,
-        artifactId = "stream-android-core",
-        version = rootProject.version.toString(),
-    )
-    configure(
-        AndroidSingleVariantLibrary(
-            variant = "release",
-            sourcesJar = true,
-            publishJavadocJar = true,
-        ),
-    )
-}