adamko-dev/dokkatoo (dev.adamko.dokkatoo-html)
### [`v2.3.1`](https://togithub.com/adamko-dev/dokkatoo/releases/tag/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](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/215](https://togithub.com/adamko-dev/dokkatoo/pull/215)
- update Java example project to demonstrate feature variants by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/217](https://togithub.com/adamko-dev/dokkatoo/pull/217)
- minor build script fixes by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/209](https://togithub.com/adamko-dev/dokkatoo/pull/209)
- Fix link to OpenSavvy Prepared by [@CLOVIS-AI](https://togithub.com/CLOVIS-AI) in [https://github.com/adamko-dev/dokkatoo/pull/222](https://togithub.com/adamko-dev/dokkatoo/pull/222)
- Fix link to OpenSavvy Pedestal by [@CLOVIS-AI](https://togithub.com/CLOVIS-AI) in [https://github.com/adamko-dev/dokkatoo/pull/223](https://togithub.com/adamko-dev/dokkatoo/pull/223)
#### New Contributors
- [@CLOVIS-AI](https://togithub.com/CLOVIS-AI) made their first contribution in [https://github.com/adamko-dev/dokkatoo/pull/222](https://togithub.com/adamko-dev/dokkatoo/pull/222)
##### Dependency updates
- Update gradlePlugin.android to v8.3.1 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/212](https://togithub.com/adamko-dev/dokkatoo/pull/212)
- Update dependency typescript to v5.4.3 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/213](https://togithub.com/adamko-dev/dokkatoo/pull/213)
- Update dependency io.kotest:kotest-bom to v5.8.1 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/207](https://togithub.com/adamko-dev/dokkatoo/pull/207)
- Update dependency [@types/react-dom](https://togithub.com/types/react-dom) to v18.2.22 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/210](https://togithub.com/adamko-dev/dokkatoo/pull/210)
- Update dependency [@tsconfig/docusaurus](https://togithub.com/tsconfig/docusaurus) to v2.0.3 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/219](https://togithub.com/adamko-dev/dokkatoo/pull/219)
- Update dependency [@types/react-dom](https://togithub.com/types/react-dom) to v18.2.23 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/220](https://togithub.com/adamko-dev/dokkatoo/pull/220)
- Update docusaurus monorepo to v3.2.0 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/221](https://togithub.com/adamko-dev/dokkatoo/pull/221)
**Full Changelog**: https://github.com/adamko-dev/dokkatoo/compare/v2.3.0...v2.3.1
### [`v2.3.0`](https://togithub.com/adamko-dev/dokkatoo/releases/tag/v2.3.0)
#### What's Changed
Key changes:
- 📚 There's [a brand new documentation site for Dokkatoo](https://adamko-dev.github.io/dokkatoo/docs/)! Filled with set up guides, examples, and even [a showcase](https://adamko-dev.github.io/dokkatoo/showcase).
- 🔨 Fix: Dokkatoo tasks would be triggered, even if they weren't required. This has now been fixed. (Thank you [@translatenix](https://togithub.com/translatenix) for [finding and reporting this](https://togithub.com/adamko-dev/dokkatoo/discussions/203)).
- ✨ 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](https://adamko-dev.github.io/dokkatoo/docs/configuring/dokka-engine-plugins).
- ✨ Feature: Dokkatoo now works automatically with Java-only projects. [Check the java-example project for information](https://togithub.com/adamko-dev/dokkatoo/tree/v2.3.0/examples/java-example/dokkatoo).
##### All changes
##### Features & Fixes
- Java projects by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/195](https://togithub.com/adamko-dev/dokkatoo/pull/195)
- Add `dokkatooPlugin` parent Configuration by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/196](https://togithub.com/adamko-dev/dokkatoo/pull/196)
- Fix Dokkatoo configurations default visibility by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/204](https://togithub.com/adamko-dev/dokkatoo/pull/204)
##### Documentation
- Dokkatoo docs update by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/187](https://togithub.com/adamko-dev/dokkatoo/pull/187)
- GHA Writerside fixes by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/188](https://togithub.com/adamko-dev/dokkatoo/pull/188)
- Create complete documentation site by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/189](https://togithub.com/adamko-dev/dokkatoo/pull/189)
- Documentation Development by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/192](https://togithub.com/adamko-dev/dokkatoo/pull/192)
- Docs development by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/198](https://togithub.com/adamko-dev/dokkatoo/pull/198)
- Add composite build example by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/200](https://togithub.com/adamko-dev/dokkatoo/pull/200)
- Docs development by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/201](https://togithub.com/adamko-dev/dokkatoo/pull/201)
- Docs development by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/202](https://togithub.com/adamko-dev/dokkatoo/pull/202)
##### Dependencies
- Update gradlePlugin.android to v8.3.0 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/190](https://togithub.com/adamko-dev/dokkatoo/pull/190)
- Update dependency gradle to v8.6 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/169](https://togithub.com/adamko-dev/dokkatoo/pull/169)
- Update dependency [@types/react-dom](https://togithub.com/types/react-dom) to v18.2.19 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/193](https://togithub.com/adamko-dev/dokkatoo/pull/193)
- Update dependency [@types/react-dom](https://togithub.com/types/react-dom) to v18.2.20 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/197](https://togithub.com/adamko-dev/dokkatoo/pull/197)
- Update dependency [@types/react-dom](https://togithub.com/types/react-dom) to v18.2.21 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/199](https://togithub.com/adamko-dev/dokkatoo/pull/199)
- Update dependency io.ktor:ktor-bom to v2.3.9 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/194](https://togithub.com/adamko-dev/dokkatoo/pull/194)
##### GitHub Actions
- GitHub Actions: allow Gradle Build Cache to be written on release branches, and tags by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/185](https://togithub.com/adamko-dev/dokkatoo/pull/185)
- Update actions/upload-artifact action to v4 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/171](https://togithub.com/adamko-dev/dokkatoo/pull/171)
- Update gradle/wrapper-validation-action action to v2 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/178](https://togithub.com/adamko-dev/dokkatoo/pull/178)
- Update gradle/gradle-build-action action to v3 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/180](https://togithub.com/adamko-dev/dokkatoo/pull/180)
**Full Changelog**: https://github.com/adamko-dev/dokkatoo/compare/v2.2.0...v2.3.0
### [`v2.2.0`](https://togithub.com/adamko-dev/dokkatoo/releases/tag/v2.2.0)
This release contains
- support for [Dokka 1.9.20](https://togithub.com/Kotlin/dokka/releases/tag/v1.9.20)
- some minor fixes and workarounds
#### What's Changed
- release 2.2.0-SNAPSHOT by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/163](https://togithub.com/adamko-dev/dokkatoo/pull/163)
- Update dependency io.ktor:ktor-bom to v2.3.8 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/167](https://togithub.com/adamko-dev/dokkatoo/pull/167)
- remove `Gradle.rootGradle` util by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/172](https://togithub.com/adamko-dev/dokkatoo/pull/172)
- Hack attributes to workaround Gradle bugs by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/173](https://togithub.com/adamko-dev/dokkatoo/pull/173)
- prevent Kotlin DSL accessor generation for internal BaseDependencyManager by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/177](https://togithub.com/adamko-dev/dokkatoo/pull/177)
- Update dependency dev.adamko.dokkatoo:dokkatoo-plugin to v2.1.0 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/179](https://togithub.com/adamko-dev/dokkatoo/pull/179)
- Update dependency org.jetbrains.kotlinx:kotlinx-serialization-bom to v1.6.3 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/181](https://togithub.com/adamko-dev/dokkatoo/pull/181)
- update Dokka to 1.9.20 by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/182](https://togithub.com/adamko-dev/dokkatoo/pull/182)
- release 2.2.0 by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/183](https://togithub.com/adamko-dev/dokkatoo/pull/183)
**Full Changelog**: https://github.com/adamko-dev/dokkatoo/compare/v2.1.0...v2.2.0
### [`v2.1.0`](https://togithub.com/adamko-dev/dokkatoo/releases/tag/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:
```diff
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](https://docs.gradle.org/current/8.6/build_cache_use_cases.html#accelerate_developer_builds_by_reusing_ci_results))
##### Updated default Dokka version to [1.9.10](https://togithub.com/Kotlin/dokka/releases/tag/v1.9.10)
If you manually [overrode the version of Dokka that Dokkatoo uses](https://togithub.com/adamko-dev/dokkatoo/issues/137#issuecomment-1890653725) 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](https://togithub.com/adamko-dev/dokkatoo/issues/122#issue-1917272309)!)
##### Configurable Worker Isolation
In previous versions Dokkatoo ran Dokka Generator in a [process isolated worker](https://docs.gradle.org/8.6/userguide/worker_api.html#creating_a_worker_daemon). For some projects this might be undesirable.
Dokkatoo can also run Dokka Generator in the current Gradle process, but with an isolated classpath.
```kotlin
// 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:
```kotlin
// 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](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/124](https://togithub.com/adamko-dev/dokkatoo/pull/124)
- add additional logging for KotlinProjectExtension failures by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/125](https://togithub.com/adamko-dev/dokkatoo/pull/125)
- bump Dokka to 1.9.10, plus dependencies by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/126](https://togithub.com/adamko-dev/dokkatoo/pull/126)
- automatically add version for Dokka dependencies by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/127](https://togithub.com/adamko-dev/dokkatoo/pull/127)
- Automatically add all-modules-page-plugin when aggregating HTML modules by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/128](https://togithub.com/adamko-dev/dokkatoo/pull/128)
- enable Renovate dependency updates by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/129](https://togithub.com/adamko-dev/dokkatoo/pull/129)
- Update README.md by [@martinbonnin](https://togithub.com/martinbonnin) in [https://github.com/adamko-dev/dokkatoo/pull/133](https://togithub.com/adamko-dev/dokkatoo/pull/133)
- Versioning plugin: allow default version order by [@martinbonnin](https://togithub.com/martinbonnin) in [https://github.com/adamko-dev/dokkatoo/pull/135](https://togithub.com/adamko-dev/dokkatoo/pull/135)
- Functional tests: assert file existence by [@martinbonnin](https://togithub.com/martinbonnin) in [https://github.com/adamko-dev/dokkatoo/pull/134](https://togithub.com/adamko-dev/dokkatoo/pull/134)
- GitHub Actions: fix checkout-ref by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/140](https://togithub.com/adamko-dev/dokkatoo/pull/140)
- \[test utils] sort file tree entries (so it's stable across OSes) by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/138](https://togithub.com/adamko-dev/dokkatoo/pull/138)
- Update dependency io.ktor:ktor-bom to v2.3.7 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/141](https://togithub.com/adamko-dev/dokkatoo/pull/141)
- Update dependency dev.adamko.kotlin.binary_compatibility_validator:bcv-gradle-plugin to v0.1.0 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/142](https://togithub.com/adamko-dev/dokkatoo/pull/142)
- Update dependency gradle to v8.5 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/143](https://togithub.com/adamko-dev/dokkatoo/pull/143)
- Update actions/setup-java action to v4 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/146](https://togithub.com/adamko-dev/dokkatoo/pull/146)
- Update actions/upload-pages-artifact action to v3 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/147](https://togithub.com/adamko-dev/dokkatoo/pull/147)
- Update actions/deploy-pages action to v3 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/145](https://togithub.com/adamko-dev/dokkatoo/pull/145)
- Update actions/checkout action to v4 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/144](https://togithub.com/adamko-dev/dokkatoo/pull/144)
- Update android-actions/setup-android action to v3 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/148](https://togithub.com/adamko-dev/dokkatoo/pull/148)
- Add option to toggle Dokka Generator Worker API isolation by [@martinbonnin](https://togithub.com/martinbonnin) in [https://github.com/adamko-dev/dokkatoo/pull/136](https://togithub.com/adamko-dev/dokkatoo/pull/136)
- add JetBrains Space publishing and consuming by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/149](https://togithub.com/adamko-dev/dokkatoo/pull/149)
- publish to and use GCP maven repo by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/151](https://togithub.com/adamko-dev/dokkatoo/pull/151)
- Update mikepenz/action-junit-report action to v4 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/152](https://togithub.com/adamko-dev/dokkatoo/pull/152)
- fix worker jvm args by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/153](https://togithub.com/adamko-dev/dokkatoo/pull/153)
- sync dependency versions with Dokka by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/154](https://togithub.com/adamko-dev/dokkatoo/pull/154)
- refactor how Android projects are handled by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/150](https://togithub.com/adamko-dev/dokkatoo/pull/150)
- Relocatable build cache v3 by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/155](https://togithub.com/adamko-dev/dokkatoo/pull/155)
- log a warning if `all-modules-page-plugin` is missing by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/158](https://togithub.com/adamko-dev/dokkatoo/pull/158)
- Updated automatic all-modules-page-plugin management by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/159](https://togithub.com/adamko-dev/dokkatoo/pull/159)
- Update gradlePlugin.android to v8.2.2 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/160](https://togithub.com/adamko-dev/dokkatoo/pull/160)
#### New Contributors
- [@renovate](https://togithub.com/renovate) made their first contribution in [https://github.com/adamko-dev/dokkatoo/pull/141](https://togithub.com/adamko-dev/dokkatoo/pull/141)
**Full Changelog**: https://github.com/adamko-dev/dokkatoo/compare/v2.0.0...v2.1.0
Configuration
📅 Schedule: Branch creation - "every weekend" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
â™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR has been generated by Mend Renovate. View repository job log here.
This PR contains the following updates:
2.0.0
->2.3.1
Release Notes
adamko-dev/dokkatoo (dev.adamko.dokkatoo-html)
### [`v2.3.1`](https://togithub.com/adamko-dev/dokkatoo/releases/tag/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](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/215](https://togithub.com/adamko-dev/dokkatoo/pull/215) - update Java example project to demonstrate feature variants by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/217](https://togithub.com/adamko-dev/dokkatoo/pull/217) - minor build script fixes by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/209](https://togithub.com/adamko-dev/dokkatoo/pull/209) - Fix link to OpenSavvy Prepared by [@CLOVIS-AI](https://togithub.com/CLOVIS-AI) in [https://github.com/adamko-dev/dokkatoo/pull/222](https://togithub.com/adamko-dev/dokkatoo/pull/222) - Fix link to OpenSavvy Pedestal by [@CLOVIS-AI](https://togithub.com/CLOVIS-AI) in [https://github.com/adamko-dev/dokkatoo/pull/223](https://togithub.com/adamko-dev/dokkatoo/pull/223) #### New Contributors - [@CLOVIS-AI](https://togithub.com/CLOVIS-AI) made their first contribution in [https://github.com/adamko-dev/dokkatoo/pull/222](https://togithub.com/adamko-dev/dokkatoo/pull/222) ##### Dependency updates - Update gradlePlugin.android to v8.3.1 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/212](https://togithub.com/adamko-dev/dokkatoo/pull/212) - Update dependency typescript to v5.4.3 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/213](https://togithub.com/adamko-dev/dokkatoo/pull/213) - Update dependency io.kotest:kotest-bom to v5.8.1 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/207](https://togithub.com/adamko-dev/dokkatoo/pull/207) - Update dependency [@types/react-dom](https://togithub.com/types/react-dom) to v18.2.22 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/210](https://togithub.com/adamko-dev/dokkatoo/pull/210) - Update dependency [@tsconfig/docusaurus](https://togithub.com/tsconfig/docusaurus) to v2.0.3 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/219](https://togithub.com/adamko-dev/dokkatoo/pull/219) - Update dependency [@types/react-dom](https://togithub.com/types/react-dom) to v18.2.23 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/220](https://togithub.com/adamko-dev/dokkatoo/pull/220) - Update docusaurus monorepo to v3.2.0 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/221](https://togithub.com/adamko-dev/dokkatoo/pull/221) **Full Changelog**: https://github.com/adamko-dev/dokkatoo/compare/v2.3.0...v2.3.1 ### [`v2.3.0`](https://togithub.com/adamko-dev/dokkatoo/releases/tag/v2.3.0) #### What's Changed Key changes: - 📚 There's [a brand new documentation site for Dokkatoo](https://adamko-dev.github.io/dokkatoo/docs/)! Filled with set up guides, examples, and even [a showcase](https://adamko-dev.github.io/dokkatoo/showcase). - 🔨 Fix: Dokkatoo tasks would be triggered, even if they weren't required. This has now been fixed. (Thank you [@translatenix](https://togithub.com/translatenix) for [finding and reporting this](https://togithub.com/adamko-dev/dokkatoo/discussions/203)). - ✨ 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](https://adamko-dev.github.io/dokkatoo/docs/configuring/dokka-engine-plugins). - ✨ Feature: Dokkatoo now works automatically with Java-only projects. [Check the java-example project for information](https://togithub.com/adamko-dev/dokkatoo/tree/v2.3.0/examples/java-example/dokkatoo). ##### All changes ##### Features & Fixes - Java projects by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/195](https://togithub.com/adamko-dev/dokkatoo/pull/195) - Add `dokkatooPlugin` parent Configuration by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/196](https://togithub.com/adamko-dev/dokkatoo/pull/196) - Fix Dokkatoo configurations default visibility by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/204](https://togithub.com/adamko-dev/dokkatoo/pull/204) ##### Documentation - Dokkatoo docs update by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/187](https://togithub.com/adamko-dev/dokkatoo/pull/187) - GHA Writerside fixes by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/188](https://togithub.com/adamko-dev/dokkatoo/pull/188) - Create complete documentation site by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/189](https://togithub.com/adamko-dev/dokkatoo/pull/189) - Documentation Development by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/192](https://togithub.com/adamko-dev/dokkatoo/pull/192) - Docs development by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/198](https://togithub.com/adamko-dev/dokkatoo/pull/198) - Add composite build example by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/200](https://togithub.com/adamko-dev/dokkatoo/pull/200) - Docs development by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/201](https://togithub.com/adamko-dev/dokkatoo/pull/201) - Docs development by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/202](https://togithub.com/adamko-dev/dokkatoo/pull/202) ##### Dependencies - Update gradlePlugin.android to v8.3.0 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/190](https://togithub.com/adamko-dev/dokkatoo/pull/190) - Update dependency gradle to v8.6 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/169](https://togithub.com/adamko-dev/dokkatoo/pull/169) - Update dependency [@types/react-dom](https://togithub.com/types/react-dom) to v18.2.19 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/193](https://togithub.com/adamko-dev/dokkatoo/pull/193) - Update dependency [@types/react-dom](https://togithub.com/types/react-dom) to v18.2.20 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/197](https://togithub.com/adamko-dev/dokkatoo/pull/197) - Update dependency [@types/react-dom](https://togithub.com/types/react-dom) to v18.2.21 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/199](https://togithub.com/adamko-dev/dokkatoo/pull/199) - Update dependency io.ktor:ktor-bom to v2.3.9 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/194](https://togithub.com/adamko-dev/dokkatoo/pull/194) ##### GitHub Actions - GitHub Actions: allow Gradle Build Cache to be written on release branches, and tags by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/185](https://togithub.com/adamko-dev/dokkatoo/pull/185) - Update actions/upload-artifact action to v4 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/171](https://togithub.com/adamko-dev/dokkatoo/pull/171) - Update gradle/wrapper-validation-action action to v2 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/178](https://togithub.com/adamko-dev/dokkatoo/pull/178) - Update gradle/gradle-build-action action to v3 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/180](https://togithub.com/adamko-dev/dokkatoo/pull/180) **Full Changelog**: https://github.com/adamko-dev/dokkatoo/compare/v2.2.0...v2.3.0 ### [`v2.2.0`](https://togithub.com/adamko-dev/dokkatoo/releases/tag/v2.2.0) This release contains - support for [Dokka 1.9.20](https://togithub.com/Kotlin/dokka/releases/tag/v1.9.20) - some minor fixes and workarounds #### What's Changed - release 2.2.0-SNAPSHOT by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/163](https://togithub.com/adamko-dev/dokkatoo/pull/163) - Update dependency io.ktor:ktor-bom to v2.3.8 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/167](https://togithub.com/adamko-dev/dokkatoo/pull/167) - remove `Gradle.rootGradle` util by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/172](https://togithub.com/adamko-dev/dokkatoo/pull/172) - Hack attributes to workaround Gradle bugs by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/173](https://togithub.com/adamko-dev/dokkatoo/pull/173) - prevent Kotlin DSL accessor generation for internal BaseDependencyManager by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/177](https://togithub.com/adamko-dev/dokkatoo/pull/177) - Update dependency dev.adamko.dokkatoo:dokkatoo-plugin to v2.1.0 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/179](https://togithub.com/adamko-dev/dokkatoo/pull/179) - Update dependency org.jetbrains.kotlinx:kotlinx-serialization-bom to v1.6.3 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/181](https://togithub.com/adamko-dev/dokkatoo/pull/181) - update Dokka to 1.9.20 by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/182](https://togithub.com/adamko-dev/dokkatoo/pull/182) - release 2.2.0 by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/183](https://togithub.com/adamko-dev/dokkatoo/pull/183) **Full Changelog**: https://github.com/adamko-dev/dokkatoo/compare/v2.1.0...v2.2.0 ### [`v2.1.0`](https://togithub.com/adamko-dev/dokkatoo/releases/tag/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: ```diff 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](https://docs.gradle.org/current/8.6/build_cache_use_cases.html#accelerate_developer_builds_by_reusing_ci_results)) ##### Updated default Dokka version to [1.9.10](https://togithub.com/Kotlin/dokka/releases/tag/v1.9.10) If you manually [overrode the version of Dokka that Dokkatoo uses](https://togithub.com/adamko-dev/dokkatoo/issues/137#issuecomment-1890653725) 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](https://togithub.com/adamko-dev/dokkatoo/issues/122#issue-1917272309)!) ##### Configurable Worker Isolation In previous versions Dokkatoo ran Dokka Generator in a [process isolated worker](https://docs.gradle.org/8.6/userguide/worker_api.html#creating_a_worker_daemon). For some projects this might be undesirable. Dokkatoo can also run Dokka Generator in the current Gradle process, but with an isolated classpath. ```kotlin // 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: ```kotlin // 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](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/124](https://togithub.com/adamko-dev/dokkatoo/pull/124) - add additional logging for KotlinProjectExtension failures by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/125](https://togithub.com/adamko-dev/dokkatoo/pull/125) - bump Dokka to 1.9.10, plus dependencies by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/126](https://togithub.com/adamko-dev/dokkatoo/pull/126) - automatically add version for Dokka dependencies by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/127](https://togithub.com/adamko-dev/dokkatoo/pull/127) - Automatically add all-modules-page-plugin when aggregating HTML modules by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/128](https://togithub.com/adamko-dev/dokkatoo/pull/128) - enable Renovate dependency updates by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/129](https://togithub.com/adamko-dev/dokkatoo/pull/129) - Update README.md by [@martinbonnin](https://togithub.com/martinbonnin) in [https://github.com/adamko-dev/dokkatoo/pull/133](https://togithub.com/adamko-dev/dokkatoo/pull/133) - Versioning plugin: allow default version order by [@martinbonnin](https://togithub.com/martinbonnin) in [https://github.com/adamko-dev/dokkatoo/pull/135](https://togithub.com/adamko-dev/dokkatoo/pull/135) - Functional tests: assert file existence by [@martinbonnin](https://togithub.com/martinbonnin) in [https://github.com/adamko-dev/dokkatoo/pull/134](https://togithub.com/adamko-dev/dokkatoo/pull/134) - GitHub Actions: fix checkout-ref by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/140](https://togithub.com/adamko-dev/dokkatoo/pull/140) - \[test utils] sort file tree entries (so it's stable across OSes) by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/138](https://togithub.com/adamko-dev/dokkatoo/pull/138) - Update dependency io.ktor:ktor-bom to v2.3.7 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/141](https://togithub.com/adamko-dev/dokkatoo/pull/141) - Update dependency dev.adamko.kotlin.binary_compatibility_validator:bcv-gradle-plugin to v0.1.0 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/142](https://togithub.com/adamko-dev/dokkatoo/pull/142) - Update dependency gradle to v8.5 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/143](https://togithub.com/adamko-dev/dokkatoo/pull/143) - Update actions/setup-java action to v4 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/146](https://togithub.com/adamko-dev/dokkatoo/pull/146) - Update actions/upload-pages-artifact action to v3 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/147](https://togithub.com/adamko-dev/dokkatoo/pull/147) - Update actions/deploy-pages action to v3 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/145](https://togithub.com/adamko-dev/dokkatoo/pull/145) - Update actions/checkout action to v4 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/144](https://togithub.com/adamko-dev/dokkatoo/pull/144) - Update android-actions/setup-android action to v3 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/148](https://togithub.com/adamko-dev/dokkatoo/pull/148) - Add option to toggle Dokka Generator Worker API isolation by [@martinbonnin](https://togithub.com/martinbonnin) in [https://github.com/adamko-dev/dokkatoo/pull/136](https://togithub.com/adamko-dev/dokkatoo/pull/136) - add JetBrains Space publishing and consuming by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/149](https://togithub.com/adamko-dev/dokkatoo/pull/149) - publish to and use GCP maven repo by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/151](https://togithub.com/adamko-dev/dokkatoo/pull/151) - Update mikepenz/action-junit-report action to v4 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/152](https://togithub.com/adamko-dev/dokkatoo/pull/152) - fix worker jvm args by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/153](https://togithub.com/adamko-dev/dokkatoo/pull/153) - sync dependency versions with Dokka by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/154](https://togithub.com/adamko-dev/dokkatoo/pull/154) - refactor how Android projects are handled by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/150](https://togithub.com/adamko-dev/dokkatoo/pull/150) - Relocatable build cache v3 by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/155](https://togithub.com/adamko-dev/dokkatoo/pull/155) - log a warning if `all-modules-page-plugin` is missing by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/158](https://togithub.com/adamko-dev/dokkatoo/pull/158) - Updated automatic all-modules-page-plugin management by [@aSemy](https://togithub.com/aSemy) in [https://github.com/adamko-dev/dokkatoo/pull/159](https://togithub.com/adamko-dev/dokkatoo/pull/159) - Update gradlePlugin.android to v8.2.2 by [@renovate](https://togithub.com/renovate) in [https://github.com/adamko-dev/dokkatoo/pull/160](https://togithub.com/adamko-dev/dokkatoo/pull/160) #### New Contributors - [@renovate](https://togithub.com/renovate) made their first contribution in [https://github.com/adamko-dev/dokkatoo/pull/141](https://togithub.com/adamko-dev/dokkatoo/pull/141) **Full Changelog**: https://github.com/adamko-dev/dokkatoo/compare/v2.0.0...v2.1.0Configuration
📅 Schedule: Branch creation - "every weekend" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
â™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.