Aggregate javadoc using build-logic

This PR has a few parts to it:
1. Adds a new `build-logic` module to organize our build logic.
2. Adds two convention plugins.
   - `sentry.javadoc` publishes the javadoc
   to a consumable configuration.
   - `sentry.javadoc.aggregate` consumes the published javadoc and
     aggregates them in the root build folder.
3. Deletes the `stylesheet.css`. This was causing the javadoc to look
   unusable. Deleting it fixes this.
4. Each subproject publishes the javadoc to its own subfolder. The
   previous behavior would overwrite the javadoc with each new project
   in the same directory which meant some parts of the javadoc were
   unreachable.

The producer/consumer configuration is based on this blog post: https://www.liutikas.net/2024/12/11/Together-In-Isolation.html
It should be project isolation compatible.

Author: runningcode

build-logic/build.gradle.kts

@@ -0,0 +1,7 @@
+plugins {
+    `kotlin-dsl`
+}
+
+repositories {
+    gradlePluginPortal()
+}

build-logic/settings.gradle.kts

@@ -0,0 +1 @@
+rootProject.name = "build-logic"

build-logic/src/main/kotlin/io/sentry/gradle/AggregateJavadoc.kt

@@ -0,0 +1,36 @@
+package io.sentry.gradle
+
+import org.gradle.api.DefaultTask
+import org.gradle.api.file.DirectoryProperty
+import org.gradle.api.file.FileCollection
+import org.gradle.api.file.FileSystemOperations
+import org.gradle.api.provider.Property
+import org.gradle.api.tasks.InputFiles
+import org.gradle.api.tasks.Internal
+import org.gradle.api.tasks.OutputDirectory
+import org.gradle.api.tasks.TaskAction
+import javax.inject.Inject
+
+abstract class AggregateJavadoc @Inject constructor(
+    @get:Internal val fs: FileSystemOperations
+) : DefaultTask() {
+    @get:InputFiles
+    abstract val javadocFiles: Property<FileCollection>
+
+    @get:OutputDirectory
+    abstract val outputDir: DirectoryProperty
+
+    @TaskAction
+    fun aggregate() {
+        javadocFiles.get().forEach { file ->
+            fs.copy {
+                // get the parts of the path and get the third to last part to use as the directory name for the output
+                val parts = file.path.split('/')
+                val projectName = parts[parts.size - 4]
+                from(file)
+                // We use the project name as the output directory name so that each javadoc goes into its own directory
+                into(outputDir.get().file(projectName))
+            }
+        }
+    }
+}

build-logic/src/main/kotlin/sentry.javadoc.aggregate.gradle.kts

@@ -0,0 +1,28 @@
+import io.sentry.gradle.AggregateJavadoc
+import org.gradle.api.attributes.Category
+import org.gradle.api.attributes.LibraryElements
+import org.gradle.kotlin.dsl.creating
+import org.gradle.kotlin.dsl.getValue
+import org.gradle.kotlin.dsl.named
+
+val javadocConsumer by configurations.creating {
+    isCanBeConsumed = false
+    isCanBeResolved = true
+    attributes {
+        attribute(Category.CATEGORY_ATTRIBUTE, objects.named(Category.DOCUMENTATION))
+        attribute(LibraryElements.LIBRARY_ELEMENTS_ATTRIBUTE, objects.named("javadoc"))
+    }
+}
+
+subprojects {
+    javadocConsumer.dependencies.add(dependencies.create(this))
+}
+
+val javadocCollection = javadocConsumer.incoming.artifactView { lenient(true) }.files
+
+tasks.register("aggregateJavadoc", AggregateJavadoc::class) {
+    group = "documentation"
+    description = "Aggregates Javadocs from all subprojects into a single directory."
+    javadocFiles.set(javadocCollection)
+    outputDir.set(layout.buildDirectory.dir("docs/javadoc"))
+}

build-logic/src/main/kotlin/sentry.javadoc.gradle.kts

@@ -0,0 +1,27 @@
+val javadocConfig: Configuration by configurations.creating {
+    isCanBeResolved = false
+    isCanBeConsumed = true
+
+    attributes {
+        attribute(Category.CATEGORY_ATTRIBUTE, objects.named(Category.DOCUMENTATION))
+        attribute(LibraryElements.LIBRARY_ELEMENTS_ATTRIBUTE, objects.named("javadoc"))
+    }
+}
+
+tasks.withType<Javadoc>().configureEach {
+    setDestinationDir(project.layout.buildDirectory.file("docs/javadoc").get().asFile)
+    title = "${project.name} $version API"
+    val opts = options as StandardJavadocDocletOptions
+    opts.quiet()
+    opts.encoding = "UTF-8"
+    opts.memberLevel = JavadocMemberLevel.PROTECTED
+    opts.links = listOf(
+        "https://docs.oracle.com/javase/8/docs/api/",
+        "https://docs.spring.io/spring-framework/docs/current/javadoc-api/",
+        "https://docs.spring.io/spring-boot/docs/current/api/"
+    )
+}
+
+artifacts {
+    add(javadocConfig.name, tasks.named("javadoc"))
+}

build.gradle.kts

@@ -27,6 +27,7 @@ plugins {
     alias(libs.plugins.errorprone) apply false
     alias(libs.plugins.gradle.versions) apply false
     alias(libs.plugins.spring.dependency.management) apply false
+    id("sentry.javadoc.aggregate")
 }
 
 buildscript {
@@ -237,7 +238,7 @@ spotless {
     kotlin {
         target("**/*.kt")
         ktlint()
-        targetExclude("**/sentry-native/**")
+        targetExclude("**/sentry-native/**", "**/build/**")
     }
     kotlinGradle {
         target("**/*.kts")
@@ -246,31 +247,6 @@ spotless {
     }
 }
 
-tasks.register("aggregateJavadocs", Javadoc::class.java) {
-    setDestinationDir(project.layout.buildDirectory.file("docs/javadoc").get().asFile)
-    title = "${project.name} $version API"
-    val opts = options as StandardJavadocDocletOptions
-    opts.quiet()
-    opts.encoding = "UTF-8"
-    opts.memberLevel = JavadocMemberLevel.PROTECTED
-    opts.stylesheetFile(file("$projectDir/docs/stylesheet.css"))
-    opts.links = listOf(
-        "https://docs.oracle.com/javase/8/docs/api/",
-        "https://docs.spring.io/spring-framework/docs/current/javadoc-api/",
-        "https://docs.spring.io/spring-boot/docs/current/api/"
-    )
-    subprojects
-        .filter { !it.name.contains("sample") && !it.name.contains("integration-tests") }
-        .forEach { proj ->
-            proj.tasks.withType<Javadoc>().forEach { javadocTask ->
-                source += javadocTask.source
-                classpath += javadocTask.classpath
-                excludes += javadocTask.excludes
-                includes += javadocTask.includes
-            }
-        }
-}
-
 tasks.register("buildForCodeQL") {
     subprojects
         .filter {