Merge Dokkatoo into Dokka Gradle Plugin #3695

adam-enko · 2024-07-17T09:27:43Z

Merge Dokkatoo into Dokka repo, and rename it to dokka-gradle-plugin.

DGP-classic has been retained, and can be toggled on/off via a property. (The used name is a placeholder, and can be re-implemented).

The DGP-classic source code has been organised into src/classicMain and src/classicTest to help keep it separated, and to prevent mixing it.

Only Dokkatoo's HTML format has been copied. GFM, Javadoc, and Jekyll were excluded.

TODO:

Rename
- package dev.adamko... -> org.jetbrains...
- Dokkatoo -> Dokka
- enableDokkatoo -> something else...
kotlinx-coroutines test breaks. Need to update Coroutines.
e: /private/var/folders/_3/ps18c9f56bx2j4fyxt0z7sn40000gp/T/junit17292292638531040000/project/buildSrc/src/main/kotlin/Dokka.kt: (18, 20): Class 'org.jetbrains.dokka.gradle.AbstractDokkaLeafTask' was compiled with an incompatible version of Kotlin. The binary version of its metadata is 1.8.0, expected version is 1.5.1.
UPDATE: fixed by using Java Toolchains & release flag

^OSIP-355

- delete old Dokkatoo dir - Add up-to-date Dokkatoo Tests pass. Still need to rename Dokkatoo->Dokka, update formatting, change package, plugin ID, disable non-HTML, update integration tests, add copyright header.

- convert dokka-subprojects to be an included build (otherwise DGP can't depend on dokka-core) - rename dokka-core to match the artifact ID (easier to understand dependencies and error messages) - merge DGP-classic into dokka-gradle-plugin - add flag to toggle between DPG-classic and Dokkatoo - Update Dokkatoo code to be Java-8 compatible

Gradle TestKit stores logs in memory and this makes the tests slower gradle/gradle#23965

- tidy up implementation - use build service to avoid `subprojects {}` (prepare for Project Isolation) gradle/gradle#22335

avoid issues with TestKit buffering logs in memory gradle/gradle#23965

- stop using `org.jetbrains.dokka.gradle.utils.sourceLink_` - weird class-not-found compilation issue - fixing build config...

use Http instead of Https connection

…gic(!)

…patible with Gradle 7)

Update enable/disable Dokkatoo flag

whyoleg

Looks fine from my side!

I've added some comments, but they are mostly out of curiosity about some Gradle usages.
I have no objections to merge it in current state and resolve anything else later

build-logic/build.gradle.kts

build-logic/src/main/kotlin/dokkabuild.gradle-plugin.gradle.kts

dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/ExperimentalFlags.kt

…r used)

# Conflicts: # dokka-integration-tests/gradle/src/testTemplateProjectTasksExecutionStress/kotlin/SequentialTasksExecutionStressTest.kt # gradle/libs.versions.toml

dokka-runners/dokka-gradle-plugin/build.gradle.kts

Tapchicoma · 2024-08-05T16:27:44Z

dokka-runners/runner-gradle-plugin-classic/build.gradle.kts

- * Code taken from the Kotlin Gradle plugin:
- * https://github.com/JetBrains/kotlin/blob/70e15b281cb43379068facb82b8e4bcb897a3c4f/buildSrc/src/main/kotlin/GradleCommon.kt#L72
- */
-fun Configuration.excludeGradleCommonDependencies() {


I don't see it in new configuration—please apply the same logic in new build script

The build config has been reworked so that the dependencies aren't added, so this exclusion does nothing.

If you run ./gradlew :dokka-gradle-plugin:publishDokkaPluginMarkerMavenPublicationToDevMavenRepo and check dokka-runners/dokka-gradle-plugin/build/dev-maven-repo/org/jetbrains/dokka/dokka-gradle-plugin/2.0.20-SNAPSHOT/dokka-gradle-plugin-2.0.20-SNAPSHOT.pom, then there's no conflicting dependencies.

We should make a test for this though... I've created a task.

https://youtrack.jetbrains.com/issue/KT-70503/Add-test-to-verify-Dokka-Plugin-does-not-expose-conflicting-dependencies

serialization brings stdlib as a transitive dependency, that is why we need this code block

I tried hard to try and discover what the issue is, but I wasn't able to discover what could go wrong. Whenever Dokka was added as a buildSrc dependency, the kotlin-stdlib and other dependencies were correctly constrained to the embedded Gradle version.

When this exclusions config was added in #2570, at the time DGP used kotlin("jvm") to build the project. This is probably what caused the issue, and the exclusions helped with that. (KGP is also built with kotlin("jvm").) DGP no longer uses kotlin("jvm"), so I don't believe it's necessary. However, out of an abundance of caution, I've added the exclusions.

dokka-runners/dokka-gradle-plugin/src/main/kotlin/adapters/AndroidAdapter.kt

dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/ExperimentalFlags.kt

dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaPlugin.kt

dokka-runners/dokka-gradle-plugin/src/testFixtures/kotlin/GradleTestKitUtils.kt

…a plugin

…the same, then jvmTarget is redundant

whyoleg

just some small minor remarks

build-logic/src/main/kotlin/dokkabuild.gradle-plugin.gradle.kts

dokka-runners/dokka-gradle-plugin/build.gradle.kts

# Conflicts: # dokka-integration-tests/gradle/src/testTemplateProjectConfiguration/kotlin/ConfigurationTest.kt # gradle/libs.versions.toml

adam-enko added 7 commits July 16, 2024 15:57

initial Dokkatoo import

bf190e7

- delete old Dokkatoo dir - Add up-to-date Dokkatoo Tests pass. Still need to rename Dokkatoo->Dokka, update formatting, change package, plugin ID, disable non-HTML, update integration tests, add copyright header.

reduce logging in Gradle integration tests

4093d0c

Gradle TestKit stores logs in memory and this makes the tests slower gradle/gradle#23965

disable stress test

99ee898

refactor workaround for included-build task-selectors

5d0f32c

- tidy up implementation - use build service to avoid `subprojects {}` (prepare for Project Isolation) gradle/gradle#22335

fix KGP tests

4ab1dd8

disable info logging in Gradle tests

54fabe9

avoid issues with TestKit buffering logs in memory gradle/gradle#23965

adam-enko added the runner: Gradle plugin An issue/PR related to Dokka's Gradle plugin label Jul 17, 2024

adam-enko added 22 commits July 17, 2024 11:32

refactor dgp build conf

fed9ec4

delete DGP-classic

7ed2808

tweak DGP build config

6824893

remove empty tests

b9c15f0

update dokkatoo package name

f9806ff

- stop using `org.jetbrains.dokka.gradle.utils.sourceLink_` - weird class-not-found compilation issue - fixing build config...

update TaskPathCollector workaround

c87f6b4

build cache Versioning0IntegrationTest to try and make it faster

bea130d

fix LogHtmlPublicationLinkTask

2f566ad

use Http instead of Https connection

undo making dokka-subprojects an IB, instead remove DGP from build-lo…

0d33a38

…gic(!)

Specify language/api as Kotlin 1.4 for dokka-gradle-plugin (to be com…

bd0978f

…patible with Gradle 7)

Add better up-to-date check for GitCheckoutTask

8af1d72

update Kotlin LV to 1.4 (to support Grade 7)

b31e518

remove debug logging

af66287

update api dump

03d8b9f

remove/tidy old config

69d83c0

use Java 21 to compile, but target Java 8

5a92608

update formatting, add copyright header

9734c27

update formatting

dd847ac

remove duplicated 'Isolation' from WorkerIsolation subtypes, & fix test

df43d03

renaming 'Dokkatoo' to 'Dokka'...

b23254d

renaming 'Dokkatoo' to 'Dokka'...

ef83bbe

Update enable/disable Dokkatoo flag

fix ExperimentalFlags package

ead8e8a

whyoleg self-requested a review August 1, 2024 11:07

whyoleg approved these changes Aug 1, 2024

View reviewed changes

adam-enko added 6 commits August 1, 2024 15:51

remove dokka-gradle-plugin from libs.versions.toml (it's no longe…

4fb3355

…r used)

set Kotlin api-version for DGP

e46fef6

Use Java 8 toolchain for DGP compilation

ed8e852

Merge branch 'refs/heads/master' into adam/feat/OSIP-355/merge-dokkatoo

b85e97c

# Conflicts: # dokka-integration-tests/gradle/src/testTemplateProjectTasksExecutionStress/kotlin/SequentialTasksExecutionStressTest.kt # gradle/libs.versions.toml

rename GradlePluginMode flag

0e001f0

Merge branch 'refs/heads/master' into adam/feat/OSIP-355/merge-dokkatoo

540cbb5

IgnatBeresnev approved these changes Aug 5, 2024

View reviewed changes

Tapchicoma reviewed Aug 6, 2024

View reviewed changes

adam-enko added 8 commits August 6, 2024 11:18

update opt-ins

2bbd942

remove duplicated plugin website/vcsUrl, move tags into specific Dokk…

2330b53

…a plugin

update 'classic mode' log to warning, and add a short link

2cb3b64

remove redundant jvmTarget config. If jvmToolchain and jvmTarget are …

2dc2fcd

…the same, then jvmTarget is redundant

Merge branch 'refs/heads/master' into adam/feat/OSIP-355/merge-dokkatoo

da32fa6

remove unused test utils code

28c3ada

formatting

4c86b2c

Merge branch 'master' into adam/feat/OSIP-355/merge-dokkatoo

7758651

whyoleg reviewed Aug 8, 2024

View reviewed changes

adam-enko mentioned this pull request Aug 8, 2024

Update DGP migration opt-in flags and messages #3736

Merged

adam-enko added 2 commits August 8, 2024 12:11

tidy up config

f097480

de-dupe Java toolchain config

e338a86

Tapchicoma approved these changes Aug 8, 2024

View reviewed changes

adam-enko added 4 commits August 13, 2024 10:17

exclude Gradle's embedded-dependencies from DGP

35495a7

remove extraneous leftover groups

1edb668

tidy

1a91447

Merge branch 'master' into adam/feat/OSIP-355/merge-dokkatoo

595b26b

# Conflicts: # dokka-integration-tests/gradle/src/testTemplateProjectConfiguration/kotlin/ConfigurationTest.kt # gradle/libs.versions.toml

adam-enko merged commit a3d5d43 into master Aug 13, 2024
14 checks passed

adam-enko deleted the adam/merge-dokkatoo branch August 13, 2024 09:57

adam-enko mentioned this pull request Aug 22, 2024

Dokka Gradle Plugin: Implement Gradle Worker Daemon for Dokka generation #2740

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merge Dokkatoo into Dokka Gradle Plugin #3695

Merge Dokkatoo into Dokka Gradle Plugin #3695

adam-enko commented Jul 17, 2024 •

edited

Loading

whyoleg left a comment

Tapchicoma Aug 5, 2024

adam-enko Aug 6, 2024 •

edited

Loading

Tapchicoma Aug 8, 2024

adam-enko Aug 13, 2024

whyoleg left a comment

Merge Dokkatoo into Dokka Gradle Plugin #3695

Merge Dokkatoo into Dokka Gradle Plugin #3695

Conversation

adam-enko commented Jul 17, 2024 • edited Loading

whyoleg left a comment

Choose a reason for hiding this comment

Tapchicoma Aug 5, 2024

Choose a reason for hiding this comment

adam-enko Aug 6, 2024 • edited Loading

Choose a reason for hiding this comment

Tapchicoma Aug 8, 2024

Choose a reason for hiding this comment

adam-enko Aug 13, 2024

Choose a reason for hiding this comment

whyoleg left a comment

Choose a reason for hiding this comment

adam-enko commented Jul 17, 2024 •

edited

Loading

adam-enko Aug 6, 2024 •

edited

Loading