From d62c70298aef776b7bedd76fcc050b14ef73daf4 Mon Sep 17 00:00:00 2001 From: Yahor Berdnikau Date: Fri, 25 Feb 2022 14:08:38 +0100 Subject: [PATCH] Disable javadoc generation on local development Currently Dokka tasks running for Gradle plugins take quite a lot of time slowing down local development cycle. This change disables publishing javadoc on non-CI builds. This could be lifted by putting 'kotlin.build.gradle.publish.javadocs=true' into local.properties. ^KT-49227 In Progress --- buildSrc/src/main/kotlin/BuildPropertiesExt.kt | 3 +++ buildSrc/src/main/kotlin/GradleCommon.kt | 10 ++++++++-- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/buildSrc/src/main/kotlin/BuildPropertiesExt.kt b/buildSrc/src/main/kotlin/BuildPropertiesExt.kt index d70244c2395..a37cd38a288 100644 --- a/buildSrc/src/main/kotlin/BuildPropertiesExt.kt +++ b/buildSrc/src/main/kotlin/BuildPropertiesExt.kt @@ -51,3 +51,6 @@ val KotlinBuildProperties.isNativeRuntimeDebugInfoEnabled: Boolean val KotlinBuildProperties.junit5NumberOfThreadsForParallelExecution: Int? get() = (getOrNull("kotlin.test.junit5.maxParallelForks") as? String)?.toInt() + +val KotlinBuildProperties.publishGradlePluginsJavadoc: Boolean + get() = getBoolean("kotlin.build.gradle.publish.javadocs", false) diff --git a/buildSrc/src/main/kotlin/GradleCommon.kt b/buildSrc/src/main/kotlin/GradleCommon.kt index 155cc7802e0..5a4699f6c7d 100644 --- a/buildSrc/src/main/kotlin/GradleCommon.kt +++ b/buildSrc/src/main/kotlin/GradleCommon.kt @@ -100,7 +100,13 @@ fun Project.configureGradlePluginCommonSettings() { .extensions .configure { withSourcesJar() - withJavadocJar() + // Enabling publishing docs jars only on CI build + // Currently dokka task runs non-incrementally and takes big amount of time + if (kotlinBuildProperties.publishGradlePluginsJavadoc || + kotlinBuildProperties.isTeamcityBuild + ) { + withJavadocJar() + } } } @@ -163,4 +169,4 @@ fun Project.publishShadowedJar( add(sourceSet.apiElementsConfigurationName, shadowJarTask) } } -} \ No newline at end of file +}