chore: modules descriptions

dieppa · dieppa · commit c75ddb5c7089 · 2025-09-21T20:21:41.000+01:00
diff --git a/cli/flamingock-cli/build.gradle.kts b/cli/flamingock-cli/build.gradle.kts
@@ -5,7 +5,7 @@ plugins {
     `maven-publish`
 }
 
-description = "Flamingock CLI"
+description = "Command-line interface for Flamingock audit and issue management operations"
 
 dependencies {
     implementation(project(":core:flamingock-core"))
diff --git a/cloud/flamingock-cloud-bom/build.gradle.kts b/cloud/flamingock-cloud-bom/build.gradle.kts
@@ -13,3 +13,5 @@ dependencies {
         // etc.
     }
 }
+
+description = "Bill of Materials for Cloud Edition dependency management"
diff --git a/cloud/flamingock-cloud/build.gradle.kts b/cloud/flamingock-cloud/build.gradle.kts
@@ -6,7 +6,7 @@ dependencies {
     testImplementation(project(":core:target-systems:nontransactional-target-system"))
 }
 
-description = "${project.name}'s description"
+description = "Cloud Edition implementation with advanced governance, observability, and SaaS features"
 
 
 tasks.withType<JavaCompile>().configureEach {
diff --git a/community/flamingock-auditstore-couchbase/build.gradle.kts b/community/flamingock-auditstore-couchbase/build.gradle.kts
@@ -9,7 +9,7 @@ dependencies {
     testImplementation("org.testcontainers:junit-jupiter:1.21.3")
 }
 
-description = "${project.name}'s description"
+description = "Couchbase audit store implementation for distributed change auditing"
 
 java {
     toolchain {
diff --git a/community/flamingock-auditstore-dynamodb/build.gradle.kts b/community/flamingock-auditstore-dynamodb/build.gradle.kts
@@ -19,7 +19,7 @@ dependencies {
     testImplementation("io.mongock:dynamodb-driver:5.5.0")
 }
 
-description = "${project.name}'s description"
+description = "Amazon DynamoDB audit store implementation for change tracking"
 
 java {
     toolchain {
diff --git a/community/flamingock-auditstore-mongodb-sync/build.gradle.kts b/community/flamingock-auditstore-mongodb-sync/build.gradle.kts
@@ -21,7 +21,7 @@ dependencies {
     testImplementation("io.mongock:mongodb-sync-v4-driver:5.5.0")
 }
 
-description = "${project.name}'s description"
+description = "MongoDB audit store implementation using synchronous MongoDB driver"
 
 java {
     toolchain {
diff --git a/community/flamingock-community-bom/build.gradle.kts b/community/flamingock-community-bom/build.gradle.kts
@@ -15,4 +15,6 @@ dependencies {
         api("io.flamingock:flamingock-springboot-integration:${version}")
         api("io.flamingock:flamingock-graalvm:${version}")
     }
-}
+}
+
+description = "Bill of Materials for Community Edition dependency management"
diff --git a/community/flamingock-community/build.gradle.kts b/community/flamingock-community/build.gradle.kts
@@ -15,7 +15,7 @@ dependencies {
     api(project(":community:flamingock-auditstore-mongodb-sync"))
 }
 
-description = "${project.name}'s description"
+description = "Community Edition aggregate module providing self-managed audit capabilities"
 
 java {
     toolchain {
diff --git a/core/flamingock-core-api/build.gradle.kts b/core/flamingock-core-api/build.gradle.kts
@@ -7,7 +7,7 @@ dependencies {
     implementation("com.fasterxml.jackson.core:jackson-core:$jacksonVersion")
 }
 
-description = "${project.name}'s description"
+description = "Public API annotations and interfaces for defining changes, stages, and templates"
 
 java {
     toolchain {
diff --git a/core/flamingock-core-commons/build.gradle.kts b/core/flamingock-core-commons/build.gradle.kts
@@ -9,7 +9,7 @@ dependencies {
     implementation("com.fasterxml.jackson.core:jackson-core:$jacksonVersion")
 }
 
-description = "${project.name}'s description"
+description = "Shared internal utilities, preview system, and common infrastructure components"
 
 java {
     toolchain {
diff --git a/core/flamingock-core/build.gradle.kts b/core/flamingock-core/build.gradle.kts
@@ -20,7 +20,7 @@ dependencies {
     testImplementation(project(":utils:test-util"))
 }
 
-description = "${project.name}'s description"
+description = "Core engine and orchestration logic for executing versioned changes across distributed systems"
 
 
 tasks.withType<JavaCompile>().configureEach {
diff --git a/core/flamingock-graalvm/build.gradle.kts b/core/flamingock-graalvm/build.gradle.kts
@@ -10,6 +10,8 @@ dependencies {
     compileOnly("org.graalvm.sdk:graal-sdk:22.3.0")
 }
 
+description = "GraalVM native image support and configuration for Flamingock applications"
+
 java {
     toolchain {
         languageVersion.set(JavaLanguageVersion.of(17))
diff --git a/core/flamingock-processor/build.gradle.kts b/core/flamingock-processor/build.gradle.kts
@@ -6,8 +6,7 @@ dependencies {
     api("com.fasterxml.jackson.core:jackson-databind:$jacksonVersion")
 }
 
-description = "Annotation processor for Flamingock. Generates code and metadata from Flamingock annotations such as " +
-        "@ChangeUnit, as well as from templated changes, enabling compile-time processing."
+description = "Annotation processor for generating change metadata and pipeline configurations from @Change annotations and YAML templates"
 
 java {
     toolchain {
diff --git a/core/importer/flamingock-importer-couchbase-tests/build.gradle.kts b/core/importer/flamingock-importer-couchbase-tests/build.gradle.kts
@@ -22,6 +22,8 @@ dependencies {
     testImplementation("org.mockito:mockito-inline:4.11.0")
 }
 
+description = "Couchbase-specific integration tests for the Flamingock importer tool"
+
 tasks.test {
     useJUnitPlatform()
 }
diff --git a/core/importer/flamingock-importer-dynamodb-tests/build.gradle.kts b/core/importer/flamingock-importer-dynamodb-tests/build.gradle.kts
@@ -17,6 +17,8 @@ dependencies {
     testImplementation("org.mockito:mockito-inline:4.11.0")
 }
 
+description = "DynamoDB-specific integration tests for the Flamingock importer tool"
+
 tasks.test {
     useJUnitPlatform()
 }
diff --git a/core/importer/flamingock-importer-mongodb-tests/build.gradle.kts b/core/importer/flamingock-importer-mongodb-tests/build.gradle.kts
@@ -15,6 +15,8 @@ dependencies {
     
 }
 
+description = "MongoDB-specific integration tests for the Flamingock importer tool"
+
 tasks.test {
     useJUnitPlatform()
 }
diff --git a/core/importer/flamingock-importer/build.gradle.kts b/core/importer/flamingock-importer/build.gradle.kts
@@ -21,7 +21,7 @@ dependencies {
     testImplementation("com.couchbase.client:java-client:3.6.0")
 }
 
-
+description = "Import tool for migrating from legacy database migration tools like Mongock to Flamingock"
 
 java {
     toolchain {
diff --git a/core/target-systems/couchbase-target-system/build.gradle.kts b/core/target-systems/couchbase-target-system/build.gradle.kts
@@ -16,7 +16,7 @@ dependencies {
     testImplementation(project(":utils:test-util"))
 }
 
-description = "${project.name}'s description"
+description = "Couchbase target system for document database change operations"
 
 java {
     toolchain {
diff --git a/core/target-systems/dynamodb-target-system/build.gradle.kts b/core/target-systems/dynamodb-target-system/build.gradle.kts
@@ -12,7 +12,7 @@ dependencies {
     testImplementation(project(":utils:test-util"))
 }
 
-description = "${project.name}'s description"
+description = "Amazon DynamoDB target system for NoSQL change operations"
 
 java {
     toolchain {
diff --git a/core/target-systems/mongodb-springdata-target-system/build.gradle.kts b/core/target-systems/mongodb-springdata-target-system/build.gradle.kts
@@ -23,7 +23,7 @@ dependencies {
     testImplementation(project(":utils:test-util"))
 }
 
-description = "${project.name}'s description"
+description = "MongoDB Spring Data target system for Spring-integrated applications"
 
 java {
     toolchain {
diff --git a/core/target-systems/mongodb-sync-target-system/build.gradle.kts b/core/target-systems/mongodb-sync-target-system/build.gradle.kts
@@ -16,7 +16,7 @@ dependencies {
     testImplementation(project(":utils:test-util"))
 }
 
-description = "${project.name}'s description"
+description = "MongoDB synchronous driver target system for database change operations"
 
 java {
     toolchain {
diff --git a/core/target-systems/nontransactional-target-system/build.gradle.kts b/core/target-systems/nontransactional-target-system/build.gradle.kts
@@ -5,7 +5,7 @@ dependencies {
     api(project(":core:flamingock-core"))
 }
 
-description = "${project.name}'s description"
+description = "Non-transactional target system implementation for simple change execution"
 
 java {
     toolchain {
diff --git a/core/target-systems/sql-target-system/build.gradle.kts b/core/target-systems/sql-target-system/build.gradle.kts
@@ -14,7 +14,7 @@ dependencies {
     testImplementation("com.zaxxer:HikariCP:4.0.3")
 }
 
-description = "${project.name}'s description"
+description = "SQL database target system for relational database change operations"
 
 java {
     toolchain {
diff --git a/templates/flamingock-mongodb-sync-template/build.gradle.kts b/templates/flamingock-mongodb-sync-template/build.gradle.kts
@@ -11,7 +11,7 @@ dependencies {
     testImplementation("org.testcontainers:junit-jupiter:1.18.3")
 }
 
-description = "${project.name}'s description"
+description = "MongoDB change templates for document database operations"
 
 java {
     toolchain {
diff --git a/templates/flamingock-sql-template/build.gradle.kts b/templates/flamingock-sql-template/build.gradle.kts
@@ -2,7 +2,7 @@ dependencies {
     implementation(project(":core:flamingock-core-commons"))
 }
 
-description = "${project.name}'s description"
+description = "SQL change templates for declarative database schema and data changes"
 
 java {
     toolchain {
diff --git a/utils/couchbase-util/build.gradle.kts b/utils/couchbase-util/build.gradle.kts
@@ -6,6 +6,8 @@ dependencies {
     testImplementation("com.couchbase.client:java-client:3.6.0")
 }
 
+description = "Couchbase utilities and client helpers for document database operations and testing"
+
 java {
     toolchain {
         languageVersion.set(JavaLanguageVersion.of(8))
diff --git a/utils/dynamodb-util/build.gradle.kts b/utils/dynamodb-util/build.gradle.kts
@@ -18,6 +18,8 @@ dependencies {
 
 }
 
+description = "Amazon DynamoDB utilities and TestContainers support for NoSQL testing and development"
+
 java {
     toolchain {
         languageVersion.set(JavaLanguageVersion.of(8))
diff --git a/utils/general-util/build.gradle.kts b/utils/general-util/build.gradle.kts
@@ -17,6 +17,8 @@ dependencies {
 
 }
 
+description = "General-purpose utilities and helper classes shared across Flamingock modules"
+
 java {
     toolchain {
         languageVersion.set(JavaLanguageVersion.of(8))
diff --git a/utils/mongodb-util/build.gradle.kts b/utils/mongodb-util/build.gradle.kts
@@ -6,6 +6,8 @@ dependencies {
     compileOnly("org.mongodb:mongodb-driver-sync:4.0.0")
 }
 
+description = "MongoDB-specific utilities and helpers for connection management and document operations"
+
 java {
     toolchain {
         languageVersion.set(JavaLanguageVersion.of(8))
diff --git a/utils/test-util/build.gradle.kts b/utils/test-util/build.gradle.kts
@@ -24,6 +24,8 @@ dependencies {
 
 }
 
+description = "Testing utilities and mock implementations for Flamingock unit and integration tests"
+
 java {
     toolchain {
         languageVersion.set(JavaLanguageVersion.of(8))

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ plugins {`
`5`	`5`	`maven-publish`
`6`	`6`	`}`
`7`	`7`
`8`		`-description = "Flamingock CLI"`
	`8`	`+description = "Command-line interface for Flamingock audit and issue management operations"`
`9`	`9`
`10`	`10`	`dependencies {`
`11`	`11`	`implementation(project(":core:flamingock-core"))`
Original file line number	Diff line number	Diff line change
`@@ -13,3 +13,5 @@ dependencies {`
`13`	`13`	`// etc.`
`14`	`14`	`}`
`15`	`15`	`}`
	`16`	`+`
	`17`	`+description = "Bill of Materials for Cloud Edition dependency management"`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ dependencies {`
`6`	`6`	`testImplementation(project(":core:target-systems:nontransactional-target-system"))`
`7`	`7`	`}`
`8`	`8`
`9`		`-description = "${project.name}'s description"`
	`9`	`+description = "Cloud Edition implementation with advanced governance, observability, and SaaS features"`
`10`	`10`
`11`	`11`
`12`	`12`	`tasks.withType<JavaCompile>().configureEach {`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ dependencies {`
`9`	`9`	`testImplementation("org.testcontainers:junit-jupiter:1.21.3")`
`10`	`10`	`}`
`11`	`11`
`12`		`-description = "${project.name}'s description"`
	`12`	`+description = "Couchbase audit store implementation for distributed change auditing"`
`13`	`13`
`14`	`14`	`java {`
`15`	`15`	`toolchain {`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ dependencies {`
`19`	`19`	`testImplementation("io.mongock:dynamodb-driver:5.5.0")`
`20`	`20`	`}`
`21`	`21`
`22`		`-description = "${project.name}'s description"`
	`22`	`+description = "Amazon DynamoDB audit store implementation for change tracking"`
`23`	`23`
`24`	`24`	`java {`
`25`	`25`	`toolchain {`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ dependencies {`
`21`	`21`	`testImplementation("io.mongock:mongodb-sync-v4-driver:5.5.0")`
`22`	`22`	`}`
`23`	`23`
`24`		`-description = "${project.name}'s description"`
	`24`	`+description = "MongoDB audit store implementation using synchronous MongoDB driver"`
`25`	`25`
`26`	`26`	`java {`
`27`	`27`	`toolchain {`
Original file line number	Diff line number	Diff line change
`@@ -15,4 +15,6 @@ dependencies {`
`15`	`15`	`api("io.flamingock:flamingock-springboot-integration:${version}")`
`16`	`16`	`api("io.flamingock:flamingock-graalvm:${version}")`
`17`	`17`	`}`
`18`		`-}`
	`18`	`+}`
	`19`	`+`
	`20`	`+description = "Bill of Materials for Community Edition dependency management"`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ dependencies {`
`15`	`15`	`api(project(":community:flamingock-auditstore-mongodb-sync"))`
`16`	`16`	`}`
`17`	`17`
`18`		`-description = "${project.name}'s description"`
	`18`	`+description = "Community Edition aggregate module providing self-managed audit capabilities"`
`19`	`19`
`20`	`20`	`java {`
`21`	`21`	`toolchain {`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ dependencies {`
`7`	`7`	`implementation("com.fasterxml.jackson.core:jackson-core:$jacksonVersion")`
`8`	`8`	`}`
`9`	`9`
`10`		`-description = "${project.name}'s description"`
	`10`	`+description = "Public API annotations and interfaces for defining changes, stages, and templates"`
`11`	`11`
`12`	`12`	`java {`
`13`	`13`	`toolchain {`