Skip to content

Remove the dependency of dokkaGenerate on dokkaGenerateModule* #3920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
whyoleg merged 5 commits into from
Nov 22, 2024
Merged

Remove the dependency of dokkaGenerate on dokkaGenerateModule* #3920

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
40ba68f
Remove the dependency of `dokkaGenerate` on `dokkaGenerateModule*`
whyoleg Nov 14, 2024
9d8e16a
Merge branch 'master' into dependson
adam-enko Nov 21, 2024
10cc480
update assertions
adam-enko Nov 21, 2024
2a65691
update assertions
adam-enko Nov 21, 2024
d0dbae7
update assertions
adam-enko Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions dokka-integration-tests/gradle/src/test/kotlin/AndroidComposeIT.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@ class AndroidComposeIT {
withClue("expect dokkaGenerate runs successfully") {
shouldHaveTask(":dokkaGenerate").shouldHaveOutcome(UP_TO_DATE, SUCCESS)
shouldHaveTask(":dokkaGeneratePublicationHtml").shouldHaveOutcome(FROM_CACHE, SUCCESS)
shouldHaveTask(":dokkaGenerateModuleHtml").shouldHaveOutcome(FROM_CACHE, SUCCESS)
}
}

Expand All @@ -118,7 +117,6 @@ class AndroidComposeIT {
}
withClue("expect dokkaGenerate* work tasks are loaded from cache") {
shouldHaveTask(":dokkaGeneratePublicationHtml").shouldHaveOutcome(FROM_CACHE)
shouldHaveTask(":dokkaGenerateModuleHtml").shouldHaveOutcome(FROM_CACHE)
}
}
}
Expand Down
2 changes: 0 additions & 2 deletions dokka-integration-tests/gradle/src/test/kotlin/AndroidProjectIT.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,6 @@ class AndroidProjectIT {
withClue("expect dokkaGenerate runs successfully") {
shouldHaveTask(":dokkaGenerate").shouldHaveOutcome(UP_TO_DATE, SUCCESS)
shouldHaveTask(":dokkaGeneratePublicationHtml").shouldHaveOutcome(FROM_CACHE, SUCCESS)
shouldHaveTask(":dokkaGenerateModuleHtml").shouldHaveOutcome(FROM_CACHE, SUCCESS)
}
}

Expand All @@ -125,7 +124,6 @@ class AndroidProjectIT {
}
withClue("expect dokkaGenerate* work tasks are loaded from cache") {
shouldHaveTask(":dokkaGeneratePublicationHtml").shouldHaveOutcome(FROM_CACHE)
shouldHaveTask(":dokkaGenerateModuleHtml").shouldHaveOutcome(FROM_CACHE)
}
}
}
Expand Down
4 changes: 0 additions & 4 deletions dokka-integration-tests/gradle/src/testExampleProjects/kotlin/ExampleProjectsTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,6 @@ class ExampleProjectsTest {
ExampleProject.Javadoc -> {
shouldHaveTasksWithOutcome(
":dokkaGeneratePublicationJavadoc" to FROM_CACHE,
":dokkaGenerateModuleJavadoc" to FROM_CACHE,
":dokkaGenerate" to UP_TO_DATE,
)
}
Expand All @@ -285,7 +284,6 @@ class ExampleProjectsTest {

ExampleProject.Multimodule -> {
shouldHaveTasksWithOutcome(
":docs:dokkaGenerateModuleHtml" to FROM_CACHE,
":childProjectA:dokkaGenerateModuleHtml" to FROM_CACHE,
":childProjectB:dokkaGenerateModuleHtml" to FROM_CACHE,
":docs:dokkaGeneratePublicationHtml" to FROM_CACHE,
Expand All @@ -295,7 +293,6 @@ class ExampleProjectsTest {

ExampleProject.VersioningMultimodule -> {
shouldHaveTasksWithOutcome(
":docs:dokkaGenerateModuleHtml" to FROM_CACHE,
":childProjectA:dokkaGenerateModuleHtml" to FROM_CACHE,
":childProjectB:dokkaGenerateModuleHtml" to FROM_CACHE,
":docs:dokkaGeneratePublicationHtml" to FROM_CACHE,
Expand All @@ -306,7 +303,6 @@ class ExampleProjectsTest {
else -> {
shouldHaveTasksWithOutcome(
":dokkaGeneratePublicationHtml" to FROM_CACHE,
":dokkaGenerateModuleHtml" to FROM_CACHE,
":dokkaGenerate" to UP_TO_DATE,
)
}
Expand Down
7 changes: 2 additions & 5 deletions dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaBasePlugin.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,7 @@ import org.jetbrains.dokka.gradle.engine.parameters.DokkaSourceSetSpec
import org.jetbrains.dokka.gradle.engine.parameters.KotlinPlatform
import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier
import org.jetbrains.dokka.gradle.internal.*
import org.jetbrains.dokka.gradle.tasks.DokkaBaseTask
import org.jetbrains.dokka.gradle.tasks.DokkaGenerateModuleTask
import org.jetbrains.dokka.gradle.tasks.DokkaGenerateTask
import org.jetbrains.dokka.gradle.tasks.TaskNames
import org.jetbrains.dokka.gradle.tasks.*
import java.io.File
import javax.inject.Inject

Expand Down Expand Up @@ -268,7 +265,7 @@ constructor(
) {
target.tasks.register<DokkaBaseTask>(taskNames.generate) {
description = "Generates Dokka publications for all formats"
dependsOn(target.tasks.withType<DokkaGenerateTask>())
dependsOn(target.tasks.withType<DokkaGeneratePublicationTask>())
}

target.tasks.withType<DokkaGenerateTask>().configureEach {
Expand Down
5 changes: 1 addition & 4 deletions dokka-runners/dokka-gradle-plugin/src/testFunctional/kotlin/MultiModuleFunctionalTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ class MultiModuleFunctionalTest : FunSpec({
test("expect build is successful") {
output shouldContainAll listOf(
"BUILD SUCCESSFUL",
"8 actionable tasks: 8 up-to-date",
"6 actionable tasks: 6 up-to-date",
)
}

Expand Down Expand Up @@ -496,9 +496,6 @@ class MultiModuleFunctionalTest : FunSpec({
"> Task :dokkaGeneratePublicationHtml",
"> Task :dokkaGeneratePublicationJavadoc",

"> Task :dokkaGenerateModuleHtml",
"> Task :dokkaGenerateModuleJavadoc",

"> Task :subproject-hello:dokkaGenerateModuleHtml",
"> Task :subproject-hello:dokkaGenerateModuleJavadoc",

Expand Down