chore(build): update build-plugin (#4)

Author: wmontwe

.gitignore

@@ -32,3 +32,6 @@ out/
 
 # Mac thumbnail db
 .DS_Store
+
+# Signing
+.signing/

build-plugin/README.md

@@ -1,68 +1,116 @@
 # Build plugins
 
-The `build-plugin` folder defines Gradle build plugins, used as single source of truth for the project configuration.
-This helps to avoid duplicated build script setups and provides a central location for all common build logic.
+The `build-plugin` project provides a set of Gradle plugins that act as the single source of truth for
+project-wide build configuration. This avoids duplicated build script setups and centralizes common build logic.
 
 ## Background
 
-We use Gradle's
-[sharing build logic in a multi-repo setup](https://docs.gradle.org/current/samples/sample_publishing_convention_plugins.html)
-to create common configuration. It allows usage of `xyz.gradle.kts` files, that are then automatically converted to
-Gradle Plugins.
+We use an included build to host our build logic as real Gradle plugins (written in Kotlin), not as legacy
+`*.gradle.kts` convention scripts. The included build is located at `build-plugin/plugin` and registers plugins
+via the Gradle `gradlePlugin` block in `build-plugin/plugin/build.gradle.kts`.
 
-The `build-plugin` is used as included build in the root `settings.gradle.kts` and provides all
-included `xyz.gradle.kts` as plugins under their `xyz` name to the whole project.
+You apply these plugins in modules using their fully-qualified plugin IDs. Each plugin focuses on a single
+responsibility; one-off configuration should stay in the module’s own `build.gradle.kts`.
 
-The plugins should try to accomplish single responsibility and leave one-off configuration to the
-module's `build.gradle.kts`.
+## Available plugins
 
-## Convention plugins
+- `net.thunderbird.gradle.plugin.app.kmp.compose` — Configures common options for Kotlin Multiplatform Compose apps
+- `net.thunderbird.gradle.plugin.library.kmp` — Configures common options for Kotlin Multiplatform libraries
+- `net.thunderbird.gradle.plugin.library.kmp.compose` — Configures common options for KMP Compose libraries
 
-- `thunderbird.app.kmp.compose` - Configures common options for Kotlin Multiplatform Compose applications
-- `thunderbird.library.kmp` - Configures common options for Kotlin Multiplatform libraries
-- `thunderbird.library.kmp.compose` - Configures common options for Kotlin Multiplatform Compose libraries
+Supportive/quality and tooling plugins:
 
-## Supportive plugins
+- `net.thunderbird.gradle.plugin.dependency.check` — [Gradle Versions Plugin](https://github.com/ben-manes/gradle-versions-plugin)
+  - Run `./gradlew dependencyUpdates` to generate a dependency update report
+- `net.thunderbird.gradle.plugin.quality.detekt` — [Detekt](https://detekt.dev/) static analysis for Kotlin
+  - Run `./gradlew detekt` to analyze, and `./gradlew detektBaseline` if you can’t fix issues yet
+- `net.thunderbird.gradle.plugin.quality.spotless` — [Spotless](https://github.com/diffplug/spotless) with
+  [Ktlint](https://pinterest.github.io/ktlint/) for formatting
+  - Run `./gradlew spotlessCheck` to verify and `./gradlew spotlessApply` to format
+- `net.thunderbird.gradle.plugin.quality.coverage` — Configures [Kover](https://github.com/Kotlin/kotlinx-kover)
+  code coverage with sensible defaults
+  - Common tasks: `./gradlew koverHtmlReport`, `./gradlew koverXmlReport`, `./gradlew koverVerify`
+- `net.thunderbird.gradle.plugin.publishing` — Configures publishing (Maven coordinates, POM metadata, and common
+  repositories like `mavenLocal()` and a local build repo under `build/maven-repo`)
 
-- `thunderbird.dependency.check` - [Gradle Versions: Gradle plugin to discover dependency updates](https://github.com/ben-manes/gradle-versions-plugin)
-  - Use `./gradlew dependencyUpdates` to generate a dependency update report
-- `thunderbird.quality.detekt` - [Detekt - Static code analysis for Kotlin](https://detekt.dev/)
-  - Use `./gradlew detekt` to check for any issue and `./gradlew detektBaseline` in case you can't fix the reported
-    issue.
-- `thunderbird.quality.spotless` - [Spotless - Code formatter](https://github.com/diffplug/spotless)
-  with [Ktlint - Kotlin linter and formatter](https://pinterest.github.io/ktlint/)
-  - Use `./gradlew spotlessCheck` to check for any issue and `./gradlew spotlessApply` to format your code
+### Applying a plugin
 
-## Add new build plugin
+In any module’s `build.gradle.kts`:
 
-Create a `thunderbird.xyz.gradle.kts` file, while `xyz` describes the new plugin.
+```
+plugins {
+    id("net.thunderbird.gradle.plugin.library.kmp")
+    // or
+    id("net.thunderbird.gradle.plugin.app.kmp.compose")
+}
+```
+
+These IDs also work in the root build script when a plugin is designed to be applied at the root (for example,
+`publishing` or top-level quality configurations):
+
+```
+plugins {
+    id("net.thunderbird.gradle.plugin.publishing")
+}
+```
 
-If you need to access dependencies that are not yet defined in `build-plugin/build.gradle.kts` you have to:
+### Code coverage configuration
 
-1. Add the dependency to the version catalog `gradle/libs.versions.toml`
-2. Then add it to `build-plugin/build.gradle.kts`.
-   1. In case of a plugin dependency use `implementation(plugin(libs.plugins.YOUR_PLUGIN_DEPENDENCY))`.
-   2. Otherwise `implementation(libs.YOUR_DEPENDENCY))`.
+When using `net.thunderbird.gradle.plugin.quality.coverage` you can tune or disable coverage checks:
 
-When done, add the plugin to `build-plugin/src/main/kotlin/ThunderbirdPlugins.kt`
+- Disable via Gradle property: `-PcodeCoverageDisabled=true`
+- Disable via environment variable: `CODE_COVERAGE_DISABLED=true`
 
-Then apply the plugin to any subproject it should be used with:
+Configure thresholds in a module’s `build.gradle.kts` using the `codeCoverage` extension:
 
 ```
-plugins {
-    id(ThunderbirdPlugins.xyz)
+codeCoverage {
+    disabled.set(false)
+    lineCoverage.set(80)
+    branchCoverage.set(70)
 }
 ```
 
-If the plugin is meant for the root `build.gradle.kts`, you can't use `ThunderbirdPlugins`, as it's not available to
-the `plugins` block. Instead use:
+Reports and verification are provided by Kover (JaCoCo backend is pinned by the plugin).
+
+### Publishing configuration
+
+The `net.thunderbird.gradle.plugin.publishing` plugin:
+
+- Applies the Vanniktech Maven Publish plugin
+- Sets Maven coordinates from the project and configures POM metadata
+- Adds local repositories: `mavenLocal()` and `${rootProject}/build/maven-repo`
+- Configures publishing to Maven Central and signs all publications
+
+Signing properties can be supplied from a file at `${rootProject}/.signing/signing.properties` with keys:
+
+- `signing.keyId`
+- `signing.password`
+- `signing.secretKeyRingFile`
+
+Alternatively, you may provide equivalent Gradle properties via other supported mechanisms.
+
+### Included build wiring
+
+These plugins are provided by an included build. The root `settings.gradle.kts` contains:
 
 ```
-plugins {
-    id("thunderbird.xyz")
-}
+includeBuild("build-plugin")
 ```
 
+## Creating a new build plugin
+
+1. Create a Kotlin plugin class under `build-plugin/plugin/src/main/kotlin/...`, implementing `Plugin<Project>`.
+2. Register it in `build-plugin/plugin/build.gradle.kts` inside the `gradlePlugin { plugins { ... } }` block with a
+   unique ID and the `implementationClass` pointing to your class.
+3. Dependencies:
+   - Add versions and aliases to the version catalog `gradle/libs.versions.toml` (if not present yet).
+   - Add the dependency to `build-plugin/plugin/build.gradle.kts`.
+     - Plugin dependency: `implementation(plugin(libs.plugins.YOUR_PLUGIN))`
+     - Library dependency: `implementation(libs.YOUR_LIBRARY)`
+
+After that, apply your plugin by its ID in any module’s `plugins` block.
+
 ## Acknowledgments
 
 - [Herding Elephants | Square Corner Blog](https://developer.squareup.com/blog/herding-elephants/)

build-plugin/build.gradle.kts

@@ -0,0 +1,4 @@
+kotlin.code.style=official
+org.gradle.caching=true
+org.gradle.parallel=true
+org.gradle.configureondemand=true

build-plugin/gradle.properties

@@ -0,0 +1,77 @@
+plugins {
+    `kotlin-dsl`
+}
+
+group = "net.thunderbird.gradle.plugin"
+
+dependencies {
+    implementation(files(libs.javaClass.superclass.protectionDomain.codeSource.location))
+
+    compileOnly(plugin(libs.plugins.android.application))
+
+    compileOnly(plugin(libs.plugins.kotlin.multiplatform))
+    compileOnly(plugin(libs.plugins.kotlin.serialization))
+
+    compileOnly(plugin(libs.plugins.compose.compiler))
+    compileOnly(plugin(libs.plugins.compose.multiplatform))
+    compileOnly(plugin(libs.plugins.compose.hot.reload))
+
+    implementation(plugin(libs.plugins.dependency.check))
+
+    implementation(plugin(libs.plugins.maven.publish))
+
+    implementation(plugin(libs.plugins.kover))
+    implementation(plugin(libs.plugins.detekt))
+    implementation(plugin(libs.plugins.spotless))
+
+    compileOnly(libs.kotlinx.datetime)
+}
+
+gradlePlugin {
+    plugins {
+        register("AppKmpCompose") {
+            id = "net.thunderbird.gradle.plugin.app.kmp.compose"
+            implementationClass = "net.thunderbird.gradle.plugin.app.kmp.compose.AppKmpComposePlugin"
+        }
+        register("LibraryKmp") {
+            id = "net.thunderbird.gradle.plugin.library.kmp"
+            implementationClass = "net.thunderbird.gradle.plugin.library.kmp.LibraryKmpPlugin"
+        }
+        register("LibraryKmpCompose") {
+            id = "net.thunderbird.gradle.plugin.library.kmp.compose"
+            implementationClass = "net.thunderbird.gradle.plugin.library.kmp.compose.LibraryKmpComposePlugin"
+        }
+
+        register("DependencyCheck") {
+            id = "net.thunderbird.gradle.plugin.dependency.check"
+            implementationClass = "net.thunderbird.gradle.plugin.dependency.check.DependencyCheckPlugin"
+        }
+
+        register("Publishing") {
+            id = "net.thunderbird.gradle.plugin.publishing"
+            implementationClass = "net.thunderbird.gradle.plugin.publishing.PublishingPlugin"
+        }
+
+        register("QualityCodeCoverage") {
+            id = "net.thunderbird.gradle.plugin.quality.coverage"
+            implementationClass = "net.thunderbird.gradle.plugin.quality.coverage.CodeCoveragePlugin"
+        }
+        register("QualityDetekt") {
+            id = "net.thunderbird.gradle.plugin.quality.detekt"
+            implementationClass = "net.thunderbird.gradle.plugin.quality.detekt.DetektPlugin"
+        }
+        register("QualitySpotless") {
+            id = "net.thunderbird.gradle.plugin.quality.spotless"
+            implementationClass = "net.thunderbird.gradle.plugin.quality.spotless.SpotlessPlugin"
+        }
+
+        register("Versioning") {
+            id = "net.thunderbird.gradle.plugin.versioning"
+            implementationClass = "net.thunderbird.gradle.plugin.versioning.VersioningPlugin"
+        }
+    }
+}
+
+private fun plugin(provider: Provider<PluginDependency>) = with(provider.get()) {
+    "$pluginId:$pluginId.gradle.plugin:$version"
+}

build-plugin/plugin/build.gradle.kts

@@ -0,0 +1,9 @@
+package net.thunderbird.gradle.plugin
+
+import org.gradle.api.plugins.ExtensionAware
+import org.gradle.kotlin.dsl.getByType
+import org.jetbrains.compose.ComposePlugin.Dependencies
+import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension
+
+internal val KotlinMultiplatformExtension.compose: Dependencies
+    get() = (this as ExtensionAware).extensions.getByType<Dependencies>()

build-plugin/plugin/src/main/kotlin/net/thunderbird/gradle/plugin/Compose.kt

@@ -0,0 +1,8 @@
+package net.thunderbird.gradle.plugin
+
+import org.gradle.accessors.dm.LibrariesForLibs
+import org.gradle.api.Project
+import org.gradle.kotlin.dsl.getByName
+
+val Project.libs
+    get(): LibrariesForLibs = extensions.getByName<LibrariesForLibs>("libs")

build-plugin/plugin/src/main/kotlin/net/thunderbird/gradle/plugin/Libs.kt

@@ -0,0 +1,40 @@
+package net.thunderbird.gradle.plugin
+
+import org.gradle.api.JavaVersion
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+
+object ProjectConfig {
+
+    const val group = "net.thunderbird"
+
+    object Android {
+        const val sdkMin = 21
+
+        // Only needed for application
+        const val sdkTarget = 35
+
+        const val sdkCompile = 36
+    }
+
+    object Compiler {
+        val javaCompatibility = JavaVersion.VERSION_11
+        val jvmTarget = JvmTarget.JVM_11
+    }
+
+    object Publishing {
+        const val year = "2025"
+        const val url = "https://github.com/thunderbird/thunderbird-mobile-components"
+
+        const val licenseName = "MPL-2.0"
+        const val licenseUrl = "https://www.mozilla.org/en-US/MPL/2.0/"
+        const val licenseDistribution = "https://www.mozilla.org/en-US/MPL/2.0/"
+
+        const val developerId = "thunderbird"
+        const val developerName = "Thunderbird Mobile Team"
+        const val developerEmail = "mobile@thunderbird.net"
+
+        const val scmUrl = "https://github.com/thunderbird/thunderbird-mobile-components"
+        const val scmConnection = "scm:git:git://github.com/thunderbird/thunderbird-mobile-components.git"
+        const val scmDeveloperConnection = "scm:git:ssh://git@github.com/thunderbird/thunderbird-mobile-components.git"
+    }
+}