v2.1.0

[aSemy]

This new release of Dokkatoo brings some significant under-the-hood changes.

Automatic all-projects-page-plugin dependency

Manually adding the all-projects-page-plugin is no longer necessary for multi-module projects - please remove this workaround:

 dependencies {
   // If using Dokkatoo v2.1.0+ a manual dependency on all-modules-page-plugin is no longer required:
-  dokkatooPluginHtml(
-    dokkatoo.versions.jetbrainsDokka.map { dokkaVersion ->
-      "org.jetbrains.dokka:all-modules-page-plugin:$dokkaVersion"
-    }
-  )
 }

If necessary, Dokkatoo will detect when all-projects-page-plugin is missing and log a warning to help diagnose problems.

Full Build Cache compatibility

Dokkatoo can now correctly use remote-build cache)

Updated default Dokka version to 1.9.10

If you manually overrode the version of Dokka that Dokkatoo uses and you want to use the default version, you can remove this.)

Improved handling of Android projects

Android projects with variants should be better supported - feedback is appreciated!)

Configurable Worker Isolation

In previous versions Dokkatoo ran Dokka Generator in a process isolated worker. For some projects this might be undesirable.

Dokkatoo can also run Dokka Generator in the current Gradle process, but with an isolated classpath.

// build.gradle.kts

dokkatoo {
  dokkaGeneratorIsolation.set(
    ClassLoaderIsolation()
  )
}

dokkaGeneratorIsolation can also be used to configure the default JVM parameters for running Dokka Generator in Process Isolation mode:

// build.gradle.kts

dokkatoo {
  dokkaGeneratorIsolation.set(
    ProcessIsolation {
      debug.set(false)
      enableAssertions.set(true)
      minHeapSize.set("64m")
      maxHeapSize.set("512m")
      // ...
    }
  )
}

Pull Request details

• html log link tests and tidying by @aSemy in html log link tests and tidying #124
• add additional logging for KotlinProjectExtension failures by @aSemy in add additional logging for KotlinProjectExtension failures #125
• bump Dokka to 1.9.10, plus dependencies by @aSemy in bump Dokka to 1.9.10, plus dependencies #126
• automatically add version for Dokka dependencies by @aSemy in automatically add version for Dokka dependencies #127
• Automatically add all-modules-page-plugin when aggregating HTML modules by @aSemy in Automatically add all-modules-page-plugin when aggregating HTML modules #128
• enable Renovate dependency updates by @aSemy in enable Renovate dependency updates #129
• Update README.md by @martinbonnin in Update README.md #133
• Versioning plugin: allow default version order by @martinbonnin in Versioning plugin: allow default version order #135
• Functional tests: assert file existence by @martinbonnin in Functional tests: assert file existence #134
• GitHub Actions: fix checkout-ref by @aSemy in GitHub Actions: fix checkout-ref #140
• [test utils] sort file tree entries (so it's stable across OSes) by @aSemy in [test utils] sort file tree entries (so it's stable across OSes) #138
• Update dependency io.ktor:ktor-bom to v2.3.7 by @renovate in Update dependency io.ktor:ktor-bom to v2.3.7 #141
• Update dependency dev.adamko.kotlin.binary_compatibility_validator:bcv-gradle-plugin to v0.1.0 by @renovate in Update dependency dev.adamko.kotlin.binary_compatibility_validator:bcv-gradle-plugin to v0.1.0 #142
• Update dependency gradle to v8.5 by @renovate in Update dependency gradle to v8.5 #143
• Update actions/setup-java action to v4 by @renovate in Update actions/setup-java action to v4 #146
• Update actions/upload-pages-artifact action to v3 by @renovate in Update actions/upload-pages-artifact action to v3 #147
• Update actions/deploy-pages action to v3 by @renovate in Update actions/deploy-pages action to v3 #145
• Update actions/checkout action to v4 by @renovate in Update actions/checkout action to v4 #144
• Update android-actions/setup-android action to v3 by @renovate in Update android-actions/setup-android action to v3 #148
• Add option to toggle Dokka Generator Worker API isolation by @martinbonnin in Add option to toggle Dokka Generator Worker API isolation #136
• add JetBrains Space publishing and consuming by @aSemy in add JetBrains Space publishing and consuming #149
• publish to and use GCP maven repo by @aSemy in publish to and use GCP maven repo #151
• Update mikepenz/action-junit-report action to v4 by @renovate in Update mikepenz/action-junit-report action to v4 #152
• fix worker jvm args by @aSemy in fix worker jvm args #153
• sync dependency versions with Dokka by @aSemy in sync dependency versions with Dokka #154
• refactor how Android projects are handled by @aSemy in refactor how Android projects are handled #150
• Relocatable build cache v3 by @aSemy in Relocatable build cache v3 #155
• log a warning if all-modules-page-plugin is missing by @aSemy in log a warning if all-modules-page-plugin is missing #158
• Updated automatic all-modules-page-plugin management by @aSemy in Updated automatic all-modules-page-plugin management #159
• Update gradlePlugin.android to v8.2.2 by @renovate in Update gradlePlugin.android to v8.2.2 #160

New Contributors

• @renovate made their first contribution in Update dependency io.ktor:ktor-bom to v2.3.7 #141

Full Changelog: v2.0.0...v2.1.0

---

This discussion was created from the release v2.1.0.