Merge pull request #1450 from SpineEventEngine/add-dokka-documentatio…

…n-to-artifacts

Add Dokka documentation to artifacts

.github/workflows/build-on-ubuntu.yml

@@ -20,7 +20,7 @@ jobs:
 
       - name: Build project and run tests
         shell: bash
-        run: ./gradlew build --stacktrace
+        run: ./gradlew build "-Dorg.gradle.jvmargs=-XX:MaxMetaspaceSize=512m"
 
       # See: https://github.com/marketplace/actions/junit-report-action
       - name: Publish Test Report

.github/workflows/build-on-windows.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Build project and run tests
         shell: cmd
         # For the reason on `--no-daemon` see https://github.com/actions/cache/issues/454
-        run: gradlew.bat build --stacktrace --no-daemon
+        run: gradlew.bat build --stacktrace --no-daemon "-Dorg.gradle.jvmargs=-XX:MaxMetaspaceSize=512m"
 
       # See: https://github.com/marketplace/actions/junit-report-action
       - name: Publish Test Report

build.gradle.kts

@@ -43,8 +43,8 @@ import io.spine.internal.gradle.publish.spinePublishing
 import io.spine.internal.gradle.report.coverage.JacocoConfig
 import io.spine.internal.gradle.report.license.LicenseReporter
 import io.spine.internal.gradle.report.pom.PomGenerator
-import io.spine.internal.gradle.test.configureLogging
-import io.spine.internal.gradle.test.registerTestTasks
+import io.spine.internal.gradle.testing.configureLogging
+import io.spine.internal.gradle.testing.registerTestTasks
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 buildscript {
@@ -102,16 +102,22 @@ spinePublishing {
         "model-assembler",
         "model-verifier",
     )
+
     destinations = with(PublishingRepos) {
         setOf(
             cloudRepo,
             gitHub("core-java"),
             cloudArtifactRegistry
         )
     }
+
     testJar {
         inclusions = setOf("server")
     }
+
+    dokkaJar {
+        enabled = true
+    }
 }
 
 allprojects {
@@ -143,6 +149,7 @@ subprojects {
         plugin("pmd")
         plugin("maven-publish")
         plugin("pmd-settings")
+        plugin("dokka-for-java")
     }
 
     java {
@@ -176,6 +183,10 @@ subprojects {
         testImplementation("io.spine.tools:spine-testlib:$spineBaseVersion")
     }
 
+    /**
+     * Force Error Prone dependencies to `2.10.0`, because in `2.11.0` the empty constructor in
+     * [com.google.errorprone.bugpatterns.CheckReturnValue] was removed leading to breaking the API.
+     */
     configurations {
         forceVersions()
         excludeProtobufLite()
@@ -186,7 +197,13 @@ subprojects {
                     "io.spine:spine-base:$spineBaseVersion",
                     "io.spine:spine-time:$spineTimeVersion",
                     "io.spine.tools:spine-testlib:$spineBaseVersion",
-                    "io.spine.tools:spine-plugin-base:$toolBaseVersion"
+                    "io.spine.tools:spine-plugin-base:$toolBaseVersion",
+                    "com.google.errorprone:error_prone_core:2.10.0",
+                    "com.google.errorprone:error_prone_annotations:2.10.0",
+                    "com.google.errorprone:error_prone_annotation:2.10.0",
+                    "com.google.errorprone:error_prone_check_api:2.10.0",
+                    "com.google.errorprone:error_prone_test_helpers:2.10.0",
+                    "com.google.errorprone:error_prone_type_annotations:2.10.0"
                 )
             }
         }

buildSrc/build.gradle.kts

@@ -63,15 +63,15 @@ val grGitVersion = "3.1.1"
  * Please check that this value matches one defined in
  *  [io.spine.internal.dependency.Kotlin.version].
  */
-val kotlinVersion = "1.6.10"
+val kotlinVersion = "1.6.21"
 
 /**
  * The version of Guava used in `buildSrc`.
  *
  * Always use the same version as the one specified in [io.spine.internal.dependency.Guava].
  * Otherwise, when testing Gradle plugins, clashes may occur.
  */
-val guavaVersion = "31.0.1-jre"
+val guavaVersion = "31.1-jre"
 
 /**
  * The version of ErrorProne Gradle plugin.
@@ -93,6 +93,41 @@ val errorProneVersion = "2.0.2"
  */
 val protobufPluginVersion = "0.8.18"
 
+/**
+ * The version of Dokka Gradle Plugins.
+ *
+ * Please keep in sync with [io.spine.internal.dependency.Dokka.version].
+ *
+ * @see <a href="https://github.com/Kotlin/dokka/releases">
+ *     Dokka Releases</a>
+ */
+val dokkaVersion = "1.6.20"
+
+configurations.all {
+    resolutionStrategy {
+        // Force Kotlin lib versions avoiding using those bundled with Gradle.
+        force(
+            "org.jetbrains.kotlin:kotlin-stdlib:$kotlinVersion",
+            "org.jetbrains.kotlin:kotlin-stdlib-common:$kotlinVersion",
+            "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlinVersion",
+            "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlinVersion",
+            "org.jetbrains.kotlin:kotlin-reflect:$kotlinVersion"
+        )
+    }
+}
+
+val jvmVersion = JavaLanguageVersion.of(11)
+
+java {
+    toolchain.languageVersion.set(jvmVersion)
+}
+
+tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
+    kotlinOptions {
+        jvmTarget = jvmVersion.toString()
+    }
+}
+
 dependencies {
     implementation("com.fasterxml.jackson.core:jackson-databind:$jacksonVersion")
     implementation("com.fasterxml.jackson.dataformat:jackson-dataformat-xml:$jacksonVersion")
@@ -103,6 +138,12 @@ dependencies {
     api("com.github.jk1:gradle-license-report:$licenseReportVersion")
     implementation("org.ajoberstar.grgit:grgit-core:${grGitVersion}")
     implementation("net.ltgt.gradle:gradle-errorprone-plugin:${errorProneVersion}")
-    implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:${kotlinVersion}")
+
+    // Add explicit dependency to avoid warning on different Kotlin runtime versions.
+    implementation("org.jetbrains.kotlin:kotlin-reflect:$kotlinVersion")
+    implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion")
+
     implementation("gradle.plugin.com.google.protobuf:protobuf-gradle-plugin:$protobufPluginVersion")
+    implementation("org.jetbrains.dokka:dokka-gradle-plugin:${dokkaVersion}")
+    implementation("org.jetbrains.dokka:dokka-base:${dokkaVersion}")
 }