Add descriptions to published gradle subprojects (#616)

Also, ensure the description is included in the generated maven pom.

Author: lesserwhirls

buildSrc/src/main/kotlin/ds3-java-sdk-publishing-common-convention.gradle.kts

@@ -74,6 +74,7 @@ val augmentPom = tasks.register("augmentPom") {
         pub.pom {
             name.set("${project.group}:${project.name}")
             url.set("https://github.com/SpectraLogic/ds3_java_sdk")
+            description.set("${project.description}")
             licenses {
                 license {
                     name.set("The Apache License, Version 2.0")

ds3-bom/build.gradle.kts

@@ -21,7 +21,7 @@ plugins {
     `java-platform`
 }
 
-description = "The ds3-bom generates a Bill of Materials (BOM) for the published DS3 SDK artifacts."
+description = "The DS3 Java SDK Bill of Materials."
 
 dependencies {
     constraints {

ds3-interfaces/build.gradle.kts

@@ -13,6 +13,9 @@
  * ****************************************************************************
  */
 
+description = "The interfaces module holds the interfaces for headers and " +
+    "metadata."
+
 plugins {
     `ds3-java-sdk-library-convention`
 }

ds3-metadata/build.gradle.kts

@@ -18,6 +18,10 @@ plugins {
     alias(libs.plugins.shadowPlugin)
 }
 
+description = "This module holds the classes for converting file system " +
+    "metadata to BlackPearl object store metadata so you can preserve and " +
+    "restore file times and OS specific metadata."
+
 dependencies {
     api(project(":ds3-interfaces"))
     api(project(":ds3-utils"))

ds3-sdk/build.gradle.kts

@@ -21,6 +21,9 @@ plugins {
     alias(libs.plugins.gitVersionPlugin)
 }
 
+description = "The BlackPearl SDK module holds the classes used to " +
+    "communicate with the BlackPearl dataport."
+
 dependencies {
     implementation(platform(libs.jacksonBom))
 

ds3-utils/build.gradle.kts

@@ -17,6 +17,9 @@ plugins {
     `ds3-java-sdk-library-convention`
 }
 
+description = "This module holds classes for utilities used to manage files and " +
+    "metadata."
+
 dependencies {
     api(project(":ds3-interfaces"))