v2.4.0

A minor release, mostly containing version bumps. There are some small fixes.

What's Changed

Fixes

• When using IntelliJ, Dokkatoo logs a localhost link for easier viewing of the Dokka HTML output. The link was incorrect when the root project name didn't match the project's directory name. This now works. #272
• If Dokkatoo can't detect the default JDK version, it tells Dokka to use JDK11 for generating links to JDK classes. This has no affect on compilation, only on links to JDK types in generated documentation. #239
• Easier configuration of DokkaPublication output directory by @aSemy in #270
• Reduce stdout logging during tests by @aSemy in #273

Docs

• Fix Typo: add suppressInheritedMembers to example by @illarionov in #271
• Add Spring Boot to Dokkatoo users by @aSemy in #237
• Add Cloudflare Web Analytics to Dokkatoo website by @aSemy in #247

Dependency updates

• Update react monorepo by @renovate in #246
• Update dependency com.microsoft.playwright:playwright to v1.43.0 by @renovate in #242
• Update dependency io.kotest:kotest-bom to v5.9.0 by @renovate in #243
• Update docusaurus monorepo to v3.3.2 by @renovate in #244
• Update gradlePlugin.android to v8.4.0 by @renovate in #245
• Update dependency clsx to v2.1.1 by @renovate in #240
• Update dependency io.ktor:ktor-bom to v2.3.11 by @renovate in #241
• Update dependency @types/react-dom to v18.2.24 by @renovate in #228
• Update dependency typescript to v5.4.4 by @renovate in #229
• Update docusaurus monorepo to v3.2.1 by @renovate in #230
• Update dependency io.ktor:ktor-bom to v2.3.10 by @renovate in #231
• Update dependency typescript to v5.4.5 by @renovate in #232
• Update gradlePlugin.android to v8.3.2 - autoclosed by @renovate in #233
• Update dependency @types/react-dom to v18.2.25 by @renovate in #234
• Update dependency com.microsoft.playwright:playwright to v1.44.0 by @renovate in #249
• Update gradlePlugin.android to v8.4.1 by @renovate in #250
• Update docusaurus monorepo to v3.4.0 by @renovate in #251
• Update dependency io.kotest:kotest-bom to v5.9.1 by @renovate in #252
• Update gradlePlugin.android to v8.4.2 by @renovate in #254
• Update gradlePlugin.android to v8.5.0 by @renovate in #255
• Update dependency io.ktor:ktor-bom to v2.3.12 by @renovate in #256
• Update dependency typescript to v5.5.2 by @renovate in #257
• Update dependency com.microsoft.playwright:playwright to v1.45.0 by @renovate in #259
• Update dependency typescript to v5.5.3 by @renovate in #260
• Update gradlePlugin.android to v8.5.1 by @renovate in #261
• Update dependency com.microsoft.playwright:playwright to v1.45.1 by @renovate in #263
• Update dependency typescript to v5.5.4 by @renovate in #264
• Update gradlePlugin.android to v8.5.2 by @renovate in #266
• Update docusaurus monorepo to v3.5.1 by @renovate in #267
• Update dependency com.microsoft.playwright:playwright to v1.46.0 by @renovate in #268
• Update docusaurus monorepo to v3.5.2 by @renovate in #269
• Update gradle/actions action to v4 by @renovate in #265

New Contributors

• @illarionov made their first contribution in #271

Full Changelog: v2.3.1...v2.4.0

v2.3.1

This is a minor patch release of Dokkatoo, containing some minor fixes and improvements.

What's Changed

• workaround bugged Gradle attributes by @aSemy in #215
• update Java example project to demonstrate feature variants by @aSemy in #217
• minor build script fixes by @aSemy in #209
• Fix link to OpenSavvy Prepared by @CLOVIS-AI in #222
• Fix link to OpenSavvy Pedestal by @CLOVIS-AI in #223

New Contributors

• @CLOVIS-AI made their first contribution in #222

Dependency updates

• Update gradlePlugin.android to v8.3.1 by @renovate in #212
• Update dependency typescript to v5.4.3 by @renovate in #213
• Update dependency io.kotest:kotest-bom to v5.8.1 by @renovate in #207
• Update dependency @types/react-dom to v18.2.22 by @renovate in #210
• Update dependency @tsconfig/docusaurus to v2.0.3 by @renovate in #219
• Update dependency @types/react-dom to v18.2.23 by @renovate in #220
• Update docusaurus monorepo to v3.2.0 by @renovate in #221

Full Changelog: v2.3.0...v2.3.1

v2.3.0

What's Changed

Key changes:

• 📚 There's a brand new documentation site for Dokkatoo! Filled with set up guides, examples, and even a showcase.
• 🔨 Fix: Dokkatoo tasks would be triggered, even if they weren't required. This has now been fixed. (Thank you @translatenix for finding and reporting this).
• ✨ Feature: If you have multiple formats, adding Dokka Engine Plugins to all formats is now easier. Just add the plugin as a dependency using dokkatooPlugin(...). Check the docs for details.
• ✨ Feature: Dokkatoo now works automatically with Java-only projects. Check the java-example project for information.

All changes

Features & Fixes

• Java projects by @aSemy in #195
• Add dokkatooPlugin parent Configuration by @aSemy in #196
• Fix Dokkatoo configurations default visibility by @aSemy in #204

Documentation

• Dokkatoo docs update by @aSemy in #187
• GHA Writerside fixes by @aSemy in #188
• Create complete documentation site by @aSemy in #189
• Documentation Development by @aSemy in #192
• Docs development by @aSemy in #198
• Add composite build example by @aSemy in #200
• Docs development by @aSemy in #201
• Docs development by @aSemy in #202

Dependencies

• Update gradlePlugin.android to v8.3.0 by @renovate in #190
• Update dependency gradle to v8.6 by @renovate in #169
• Update dependency @types/react-dom to v18.2.19 by @renovate in #193
• Update dependency @types/react-dom to v18.2.20 by @renovate in #197
• Update dependency @types/react-dom to v18.2.21 by @renovate in #199
• Update dependency io.ktor:ktor-bom to v2.3.9 by @renovate in #194

GitHub Actions

• GitHub Actions: allow Gradle Build Cache to be written on release branches, and tags by @aSemy in #185
• Update actions/upload-artifact action to v4 by @renovate in #171
• Update gradle/wrapper-validation-action action to v2 by @renovate in #178
• Update gradle/gradle-build-action action to v3 by @renovate in #180

Full Changelog: v2.2.0...v2.3.0

v2.2.0

This release contains

• support for Dokka 1.9.20
• some minor fixes and workarounds

What's Changed

• release 2.2.0-SNAPSHOT by @aSemy in #163
• Update dependency io.ktor:ktor-bom to v2.3.8 by @renovate in #167
• remove Gradle.rootGradle util by @aSemy in #172
• Hack attributes to workaround Gradle bugs by @aSemy in #173
• prevent Kotlin DSL accessor generation for internal BaseDependencyManager by @aSemy in #177
• Update dependency dev.adamko.dokkatoo:dokkatoo-plugin to v2.1.0 by @renovate in #179
• Update dependency org.jetbrains.kotlinx:kotlinx-serialization-bom to v1.6.3 by @renovate in #181
• update Dokka to 1.9.20 by @aSemy in #182
• release 2.2.0 by @aSemy in #183

Full Changelog: v2.1.0...v2.2.0

v2.1.0

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

New Contributors

• @renovate made their first contribution in #141

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

v2.0.0

A big update!

Summary

• Dokkatoo now supports Dokka 1.9.0 by default
• Minimum supported version of Gradle is 8.0
• Deprecated functions have been removed

What's Changed

• update to Gradle 8 by @aSemy in #97
• Remove deprecated code by @aSemy in #108
• Create CONTRIBUTING.md by @aSemy in #109
• minor Windows integration tests improvements by @aSemy in #112
• Improve Windows tests on GitHub Workflow by @aSemy in #33
• Fix collection of KotlinCompilation classpath using stable Kotlin Gradle Plugin API by @antohaby in #114
• Maven Central publishing by @aSemy in #116
• Update Dokka to 1.9.0 by @EdricChan03 in #118
• release/v2.0.0 by @aSemy in #119

New Contributors

• @antohaby made their first contribution in #114
• @EdricChan03 made their first contribution in #118

Full Changelog: v1.6.0...v2.0.0

v1.6.0

Some minor bug fixes.

What's Changed

• improve localhost link logging by increasing the ServerActiveCheck timeout #100
• Integration Test setup: fix relative path error for Android SDK #102
• fix #99 fetching Android classes from subprojects #101
• fix #98 add readme.txt to Javadoc JAR #103

Full Changelog: v1.5.0...v1.6.0

v1.5.0

Incremental improvements to Dokkatoo. The most significant change is that Dokkatoo now uses Dokka 1.8.20 by default.

What's Changed

• improve URL logging link by @aSemy in #87
• update Dokka version to 1.8.20 by @aSemy in #89
• bump Kotest, Dokkatoo, Gradle Plugin Publish, KxS, Dokka by @aSemy in #90
• move :docs into modules dir by @aSemy in #93
• Create script for releasing by @aSemy in #92

Full Changelog: v1.4.0...v1.5.0

v1.4.0

This is a big release! Lots of fixes, and some deprecations.

• Support for Android projects has been improved.
• Minimum supported Android Gradle Plugin version changed from 4.0.1 to 4.2.2
• java.net.URL have been replaced with java.net.URI, to better support Gradle caching
• Dokkatoo's DSL has been improved so that Gradle will generate more type-safe accessors.
• Lots of build config updates to make configuring the projects used for integration tests easier to manage
• DokkatooPrepareParametersTask and DokkatooTask.WithSourceSets have been deprecated, so as to better support Gradle caching. This should only impact those who were manually configuring the tasks rather than using the extension DSL, which I suspect no one is doing.

Thanks to @martinbonnin, @hfhbd, and @EdricChan03 for their help with reporting and tracking down bugs!

What's Changed

• Fix DokkaGenerator not clearing deleted files by @aSemy in #60
• Mention all-modules-page-plugin in README.md by @martinbonnin in #62
• Feat/improve plugin DSL by @aSemy in #63
• Replace URL with URI by @martinbonnin in #65
• fix typo in package, distibutions -> distributions by @aSemy in #74
• big refactor of Parameter/Generator tasks, to better support Grade caching by @aSemy in #69
• Update logo by @aSemy in #75
• update IJ excludes, to be a little more simple & comprehensive by @aSemy in #79
• refactor example projects Gradle utils by @aSemy in #80
• Fix/unknown Android classes by @aSemy in #76
• remove NDOC extensions from tasks by @aSemy in #81
• Fix workaround for nested module directories by @aSemy in #85
• fix convention for package-list URL by @aSemy in #86

New Contributors

• @martinbonnin made their first contribution in #62

Full Changelog: v1.3.0...v1.4.0

v1.3.0

What's Changed

This release contains some under-the-hood fixes for Kotlin Multiplatform and Android projects.

There is one breaking change:

• AndroidJVM has been added to KotlinPlatform.

There is one deprecation:

• KotlinPlatform.key is deprecated.

Summary

• Fix: don't filter subprojects out from a KSS classpath by @aSemy in #58
• Refactor DokkatooKotlinAdapter, fix AndroidJVM target, add DokkatooAndroidAdapter by @aSemy in #59

Full Changelog: v1.2.0...v1.3.0