Skip to content

Commit

Permalink
Add descriptions to published gradle subprojects (#616)
Browse files Browse the repository at this point in the history
Also, ensure the description is included in the generated maven pom.
  • Loading branch information
lesserwhirls authored May 16, 2023
1 parent 4edf9c8 commit 879b173
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
2 changes: 1 addition & 1 deletion ds3-bom/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
3 changes: 3 additions & 0 deletions ds3-interfaces/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
* ****************************************************************************
*/

description = "The interfaces module holds the interfaces for headers and " +
"metadata."

plugins {
`ds3-java-sdk-library-convention`
}
4 changes: 4 additions & 0 deletions ds3-metadata/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -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"))
Expand Down
3 changes: 3 additions & 0 deletions ds3-sdk/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -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))

Expand Down
3 changes: 3 additions & 0 deletions ds3-utils/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -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"))

Expand Down

0 comments on commit 879b173

Please sign in to comment.