Enhance Maven publishing configuration and update POM properties

Author: DavDo

build.gradle

@@ -9,8 +9,9 @@ buildscript {
 }
 
 plugins {
-  alias libs.plugins.maven.publish
   alias libs.plugins.dokka
+  alias libs.plugins.dokkaJavadoc
+  alias libs.plugins.maven.publish
   alias libs.plugins.kt.lint
   alias libs.plugins.kotlin.android apply false
   alias libs.plugins.paparazzi apply false
@@ -20,15 +21,6 @@ apply from: "${rootDir}/scripts/version-updater.gradle"
 
 allprojects {
 
-  project.ext {
-    PUBLISH_GROUP_ID = 'com.glia'
-    PUBLISH_VERSION = widgetsVersionName
-    PUBLISH_ARTIFACT_ID = 'android-widgets'
-    PUBLISH_MODULE_DESCRIPTION = 'Glia Android Widgets SDK'
-    PUBLISH_ORGANISATION_NAME = 'Glia'
-    PUBLISH_ORGANISATION_URL = 'https://www.glia.com/'
-  }
-
   repositories {
     google()
     mavenCentral()
@@ -109,5 +101,3 @@ dokka {
     dokkaPlugin(libs.java.dokka)
   }
 }
-
-apply from: "${rootDir}/scripts/publish-module.gradle"

gradle.properties

@@ -34,3 +34,19 @@ mavenCentralPassword=
 signing.keyId=
 signing.password=
 signing.secretKeyRingFile=
+
+# POM configuration for Maven Central
+POM_NAME=android-widgets
+POM_DESCRIPTION=Glia Android Widgets SDK
+POM_INCEPTION_YEAR=2021
+POM_URL=https://www.glia.com/
+
+POM_LICENSE_URL=https://raw.githubusercontent.com/salemove/android-sdk-widgets/master/LICENSE.txt
+
+POM_SCM_URL=https://github.com/salemove/android-sdk-widgets.git
+
+POM_DEVELOPER_NAME=Glia Technologies
+POM_DEVELOPER_URL=https://www.glia.com/
+
+POM_ORGANIZATION_NAME=Glia Technologies
+POM_ORGANIZATION_URL=https://www.glia.com/

gradle/libs.versions.toml

@@ -89,6 +89,7 @@ debug-leakcanary = { module = "com.squareup.leakcanary:leakcanary-android", vers
 
 [plugins]
 dokka = { id = "org.jetbrains.dokka", version.ref = "dokkaVersion" }
+dokkaJavadoc = { id = "org.jetbrains.dokka-javadoc", version.ref = "dokkaVersion" }
 kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlinVersion" }
 kt-lint = { id = "org.jlleitschuh.gradle.ktlint", version.ref = "ktlintVersion" }
 paparazzi = { id = "app.cash.paparazzi", version.ref = "paparazziVersion" }

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 #Tue Jun 04 18:12:06 EEST 2024
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

scripts/publish-module.gradle

@@ -1,6 +1,10 @@
+import com.vanniktech.maven.publish.AndroidSingleVariantLibrary
+
 apply plugin: 'com.android.library'
 apply plugin: 'org.jetbrains.kotlin.android'
 apply plugin: 'kotlin-parcelize'
+apply plugin: 'com.vanniktech.maven.publish'
+apply plugin: 'org.jetbrains.dokka-javadoc'
 
 //Detailed information about advantages of Java toolchain https://developer.android.com/build/jdks#toolchain
 java {
@@ -85,6 +89,40 @@ android {
   }
 }
 
+group = 'com.glia'
+
+mavenPublishing {
+  def isSnapshot = findProperty("snapshot")?.toString() == "yes"
+  //Plugin automatically publishes snapshot to the Maven Central when the version name ends with `-SNAPSHOT`
+  //To publish snapshot release simply call the publishing command with gradle property `-Psnapshot=yes`
+  //for example `./gradlew androidSdk:publishMavenPublicationToMavenLocal -Psnapshot=yes`
+
+  version = isSnapshot ? widgetsVersionName + "-SNAPSHOT" : widgetsVersionName
+  coordinates(group, 'android-widgets', version)
+  configure(new AndroidSingleVariantLibrary('release', true, false/* enable javadoc generation */))
+
+  pom {
+    excludeOptionalDependencies(it)
+  }
+}
+
+//Excludes the Firebase Messaging from the .aar dependencies to avoid requiring integrators to include them in their applications.
+def excludeOptionalDependencies(mavenPom) {
+  mavenPom.withXml {
+    final pomNode = asNode()
+    pomNode.dependencyManagement.dependencies.'*'.findAll() {
+      it.artifactId.text() == 'firebase-bom'
+    }.each() {
+      it.parent().remove(it)
+    }
+    pomNode.dependencies.'*'.findAll() {
+      it.artifactId.text() == 'firebase-messaging'
+    }.each() {
+      it.parent().remove(it)
+    }
+  }
+}
+
 tasks.register('publishSnapshotPublicationToMavenLocal', GradleBuild) {
   description = 'Publishes the Snapshot publication to Maven Local with -SNAPSHOT suffix'
   group = 'publishing'
@@ -112,6 +150,25 @@ tasks.register("publishCoreSdkToLocalMaven") {
   }
 }
 
+// For generating Javadoc jar using Dokka
+tasks.register('dokkaJavadocJar', Jar.class) {
+  dependsOn(dokkaGeneratePublicationJavadoc)
+  from(dokkaGeneratePublicationJavadoc)
+  archiveClassifier.set("javadoc")
+}
+
+// CRITICAL: Ensure the Dokka JAR is included in the published artifacts.
+afterEvaluate {
+  publishing {
+    publications {
+      maven(MavenPublication) {
+        // CRITICAL: Add the generated Javadoc jar to the published artifacts.
+        artifact dokkaJavadocJar
+      }
+    }
+  }
+}
+
 apply from: "${rootProject.projectDir}/scripts/direct-core.gradle"
 
 dependencies {
@@ -176,5 +233,3 @@ configurations.configureEach {
   // Always check remote repo for changing modules (SNAPSHOTs)
   resolutionStrategy.cacheChangingModulesFor 0, 'seconds'
 }
-
-apply from: "${rootProject.projectDir}/scripts/publish-module.gradle"