diff options
| author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-11-10 11:46:54 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-10 11:46:54 +0100 |
| commit | 8e5c63d035ef44a269b8c43430f43f5c8eebfb63 (patch) | |
| tree | 1b915207b2b9f61951ddbf0ff2e687efd053d555 /runners/gradle-plugin | |
| parent | a44efd4ba0c2e4ab921ff75e0f53fc9335aa79db (diff) | |
| download | dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.tar.gz dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.tar.bz2 dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.zip | |
Restructure the project to utilize included builds (#3174)
* Refactor and simplify artifact publishing
* Update Gradle to 8.4
* Refactor and simplify convention plugins and build scripts
Fixes #3132
---------
Co-authored-by: Adam <897017+aSemy@users.noreply.github.com>
Co-authored-by: Oleg Yukhnevich <whyoleg@gmail.com>
Diffstat (limited to 'runners/gradle-plugin')
60 files changed, 0 insertions, 5419 deletions
diff --git a/runners/gradle-plugin/MIGRATION.md b/runners/gradle-plugin/MIGRATION.md deleted file mode 100644 index 7f881bfa..00000000 --- a/runners/gradle-plugin/MIGRATION.md +++ /dev/null @@ -1,167 +0,0 @@ -### Configuring a dokka task -Dokka 1.4.x will create dedicated tasks for each format. -You can expect the following formats being registered and configured by default: -- `dokkaHtml` -- `dokkaJavadoc` -- `dokkaGfm` -- `dokkaJekyll` - -Therefore, you need to either select specifically which task you want to configure or configure all with Type `DokkaTask` - -```kotlin -/* 0.10.x */ -tasks.dokka.configure { /*...*/ } - -/* 1.4.x */ -// configure all formats -tasks.withType<DokkaTask>().configureEach { /*...*/ } - -// configure only html format e.g. -tasks.dokkaHtml.configure { /*...*/ } -``` - -#### properties -```kotlin -/* 0.10.x */ outputFormat = "html" -/* 1.4.x No equivalent. - Formats are only configured by plugins. - See `dokkaHtml`, `dokkaJavadoc`,... tasks */ - -/* 0.10.x */ outputDirectory = "$buildDir/javadoc" -/* 1.4.x */ outputDirectory.set(buildDir.resolve("javadoc")) - - -/* 0.10.x */ subProjects = ["subproject1", "subproject2"] -/* 1.4.x No equivalent. - See `DokkaCollectorTask` and `DokkaMultiModuleTask` */ - - -/* 0.10.x */ disableAutoconfiguration = false -/* 1.4.x No equivalent. - Source sets are synced with Kotlin Model by default. - All settings can still be overridden */ - -/* 0.10.x */ cacheRoot = "default" -/* 1.4.x */ cacheRoot.set(file("default")) - -``` - -### Configure a source set -```kotlin -/* 0.10.x */ -tasks.dokka.configure { - configuration { - // ... - } -} - -/* 1.4.x */ -tasks.dokkaHtml.configure { - dokkaSourceSets { - named("main") { /* configure main source set */ } - configureEach { /* configure all source sets */ } - register("custom") { /* register custom source set */ } - } -} -``` - -#### Properties -```kotlin -/* 0.10.x */ moduleName = "myModule" -/* 1.4.0 */ /* Use AbstractDokkaTask#moduleDisplayName instead */ -/* 1.4.10+ */ /* Use AbstractDokkaTask#moduleName instead */ - -/* 0.10.x */ includeNonPublic = false -/* 1.4.x */ includeNonPublic.set(false) - -/* 0.10.x */ skipDeprecated = false -/* 1.4.x */ skipDeprecated.set(false) - -/* 0.10.x */ reportUndocumented = true -/* 1.4.x */ reportUndocumented.set(true) - -/* 0.10.x */ skipEmptyPackages = true -/* 1.4.x */ skipEmptyPackages.set(true) - -/* 0.10.x */ targets = ["JVM"] -/* 1.4.x */ /* No equivalent */ - /* Use platform and displayName instead */ - -/* 0.10.x */ platform = "JVM" -/* 1.4.x */ platform.set(org.jetbrains.dokka.Platform.jvm) -/* 1.4.x */ platform.set(Platform.jvm) // with import - -/* 0.10.x */ classpath = [new File("$buildDir/other.jar")] -/* 1.4.x */ classpath.setFrom(buildDir.resolve("other.jar")) // setting classpath -/* 1.4.x */ classpath.from(buildDir.resolve("other.jar")) // adding to existing classpath - -/* 0.10.x */ sourceRoots = [files("src/main/kotlin")] -/* 1.4.x */ sourceRoots.setFrom(file("src/main/kotlin")) // setting all source roots -/* 1.4.x */ sourceRoots.from(file("src/main/kotlin")) // adding to existing source roots - -/* 0.10.x */ includes = ["packages.md", "extra.md"] -/* 1.4.x */ includes.setFrom(files("packages.md", "extra.md")) // setting all includes -/* 1.4.x */ includes.from(files("packages.md", "extra.md")) // adding to existing includes - -/* 0.10.x */ samples = ["samples/basic.kt", "samples/advanced.kt"] -/* 1.4.x */ samples.setFrom(files("samples/basic.kt", "samples/advanced.kt")) -/* 1.4.x */ samples.from(files("samples/basic.kt", "samples/advanced.kt")) - -/* 0.10.x */ kotlinTasks { /* ... */ } -/* 1.4.x */ /* No *direct* equivalent */ - /* Source sets synced with Kotlin Gradle Plugin will be configured properly */ - /* Custom source sets can use extension `kotlinSourceSet(...)` */ - -/* 0.10.x */ jdkVersion = 6 -/* 1.4.x */ jdkVersion.set(6) - -/* 0.10.x */ noStdlibLink = false -/* 1.4.x */ noStdlibLink.set(false) - -/* 0.10.x */ noJdkLink = false -/* 1.4.x */ noJdkLink.set(false) - -sourceLink { - /* 0.10.x */ path = "src/main/kotlin" - /* 1.4.x */ localDirectory.set(file("src/main/kotlin")) - - /* 0.10.x */ url = "https://github.com/myproject/blob/master/src/main/kotlin" - /* 1.4.x */ remoteUrl.set(java.net.URL("https://github.com/myproject/blob/master/src/main/kotlin")) - /* 1.4.x */ remoteUrl.set(uri("https://github.com/myproject/blob/master/src/main/kotlin").toURL()) - - /* 0.10.x */ lineSuffix = "#L" - /* 1.4.x */ remoteLineSuffix.set("#L") -} - - -externalDocumentationLink { - /* 0.10.x */ url = URL("https://example.com/docs/") - /* 1.4.x */ url.set(URL("https://example.com/docs/")) - - /* 0.10.x */ packageListUrl = URL("file:///home/user/localdocs/package-list") - /* 1.4.x */ packageListUrl.set(URL("file:///home/user/localdocs/package-list")) -} - -// Allows to customize documentation generation options on a per-package basis -// Repeat for multiple packageOptions -perPackageOption { - /* 0.10.x */ prefix = "kotlin" - /* 1.4.x */ prefix.set("kotlin") - /* 1.4.20+ */ matchingRegex("kotlin($|\\.).*") - - /* 0.10.x */ skipDeprecated = false - /* 1.4.x */ skipDeprecated.set(false) - - /* 0.10.x */ reportUndocumented = true - /* 1.4.x */ reportUndocumented.set(true) - - /* 0.10.x */ includeNonPublic = false - /* 1.4.x */ includeNonPublic.set(false) - - /* 0.10.x */ suppress = true - /* 1.4.x */ suppress.set(true) - -} -``` - -For more information or help, feel free to ask questions in the [official Kotlin Slack Channel](https://kotlinlang.slack.com/) diff --git a/runners/gradle-plugin/api/gradle-plugin.api b/runners/gradle-plugin/api/gradle-plugin.api deleted file mode 100644 index 0ec172b7..00000000 --- a/runners/gradle-plugin/api/gradle-plugin.api +++ /dev/null @@ -1,181 +0,0 @@ -public abstract class org/jetbrains/dokka/gradle/AbstractDokkaLeafTask : org/jetbrains/dokka/gradle/AbstractDokkaTask { - public fun <init> ()V - public final fun getDokkaSourceSets ()Lorg/gradle/api/NamedDomainObjectContainer; - protected final fun getUnsuppressedSourceSets ()Ljava/util/List; -} - -public abstract class org/jetbrains/dokka/gradle/AbstractDokkaParentTask : org/jetbrains/dokka/gradle/AbstractDokkaTask { - public fun <init> ()V - public final fun addChildTask (Ljava/lang/String;)V - public final fun addChildTask (Lorg/jetbrains/dokka/gradle/AbstractDokkaTask;)V - public final fun addChildTasks (Ljava/lang/Iterable;Ljava/lang/String;)V - public final fun addSubprojectChildTasks (Ljava/lang/String;)V - public final fun removeChildTask (Ljava/lang/String;)V - public final fun removeChildTask (Lorg/jetbrains/dokka/gradle/AbstractDokkaTask;)V - public final fun removeChildTasks (Ljava/lang/Iterable;)V - public final fun removeChildTasks (Ljava/lang/Iterable;Ljava/lang/String;)V - public final fun removeChildTasks (Lorg/gradle/api/Project;)V - public final fun removeSubprojectChildTasks (Ljava/lang/String;)V -} - -public abstract class org/jetbrains/dokka/gradle/AbstractDokkaTask : org/gradle/api/DefaultTask { - public fun <init> ()V - public final fun doFirst (Lgroovy/lang/Closure;)Lorg/gradle/api/Task; - public final fun doFirst (Lorg/gradle/api/Action;)Lorg/gradle/api/Task; - public abstract fun getCacheRoot ()Lorg/gradle/api/file/DirectoryProperty; - public final fun getFailOnWarning ()Lorg/gradle/api/provider/Property; - public final fun getModuleName ()Lorg/gradle/api/provider/Property; - public final fun getModuleVersion ()Lorg/gradle/api/provider/Property; - public final fun getOfflineMode ()Lorg/gradle/api/provider/Property; - public abstract fun getOutputDirectory ()Lorg/gradle/api/file/DirectoryProperty; - public final fun getPlugins ()Lorg/gradle/api/artifacts/Configuration; - public final fun getPluginsConfiguration ()Lorg/gradle/api/provider/ListProperty; - public final fun getPluginsMapConfiguration ()Lorg/gradle/api/provider/MapProperty; - public final fun getRuntime ()Lorg/gradle/api/artifacts/Configuration; - public final fun getSuppressInheritedMembers ()Lorg/gradle/api/provider/Property; - public final fun getSuppressObviousFunctions ()Lorg/gradle/api/provider/Property; -} - -public final class org/jetbrains/dokka/gradle/DokkaBootstrapFactoryKt { - public static final fun DokkaBootstrap (Lorg/gradle/api/artifacts/Configuration;Lkotlin/reflect/KClass;)Lorg/jetbrains/dokka/DokkaBootstrap; -} - -public abstract class org/jetbrains/dokka/gradle/DokkaCollectorTask : org/jetbrains/dokka/gradle/AbstractDokkaParentTask { - public fun <init> ()V -} - -public abstract interface class org/jetbrains/dokka/gradle/DokkaMultiModuleFileLayout { - public abstract fun targetChildOutputDirectory (Lorg/jetbrains/dokka/gradle/DokkaMultiModuleTask;Lorg/jetbrains/dokka/gradle/AbstractDokkaTask;)Lorg/gradle/api/provider/Provider; -} - -public final class org/jetbrains/dokka/gradle/DokkaMultiModuleFileLayout$CompactInParent : org/jetbrains/dokka/gradle/DokkaMultiModuleFileLayout { - public static final field INSTANCE Lorg/jetbrains/dokka/gradle/DokkaMultiModuleFileLayout$CompactInParent; - public fun targetChildOutputDirectory (Lorg/jetbrains/dokka/gradle/DokkaMultiModuleTask;Lorg/jetbrains/dokka/gradle/AbstractDokkaTask;)Lorg/gradle/api/provider/Provider; -} - -public final class org/jetbrains/dokka/gradle/DokkaMultiModuleFileLayout$NoCopy : org/jetbrains/dokka/gradle/DokkaMultiModuleFileLayout { - public static final field INSTANCE Lorg/jetbrains/dokka/gradle/DokkaMultiModuleFileLayout$NoCopy; - public fun targetChildOutputDirectory (Lorg/jetbrains/dokka/gradle/DokkaMultiModuleTask;Lorg/jetbrains/dokka/gradle/AbstractDokkaTask;)Lorg/gradle/api/provider/Provider; -} - -public abstract class org/jetbrains/dokka/gradle/DokkaMultiModuleTask : org/jetbrains/dokka/gradle/AbstractDokkaParentTask { - public fun <init> ()V - public final fun getFileLayout ()Lorg/gradle/api/provider/Property; - public abstract fun getIncludes ()Lorg/gradle/api/file/ConfigurableFileCollection; - public fun getTaskDependencies ()Lorg/gradle/api/internal/tasks/TaskDependencyInternal; - public synthetic fun getTaskDependencies ()Lorg/gradle/api/tasks/TaskDependency; -} - -public class org/jetbrains/dokka/gradle/DokkaPlugin : org/gradle/api/Plugin { - public fun <init> ()V - public synthetic fun apply (Ljava/lang/Object;)V - public fun apply (Lorg/gradle/api/Project;)V -} - -public abstract class org/jetbrains/dokka/gradle/DokkaTask : org/jetbrains/dokka/gradle/AbstractDokkaLeafTask { - public fun <init> ()V -} - -public abstract class org/jetbrains/dokka/gradle/DokkaTaskPartial : org/jetbrains/dokka/gradle/AbstractDokkaLeafTask { - public fun <init> ()V -} - -public class org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilder : org/jetbrains/dokka/DokkaConfigurationBuilder { - public fun <init> (Ljava/lang/String;Lorg/gradle/api/Project;Lorg/gradle/api/NamedDomainObjectFactory;)V - public final fun DokkaSourceSetID (Ljava/lang/String;)Lorg/jetbrains/dokka/DokkaSourceSetID; - public synthetic fun build ()Ljava/lang/Object; - public fun build ()Lorg/jetbrains/dokka/DokkaSourceSetImpl; - public final fun dependsOn (Ljava/lang/String;)V - public final fun dependsOn (Lorg/gradle/api/tasks/SourceSet;)V - public final fun dependsOn (Lorg/jetbrains/dokka/DokkaConfiguration$DokkaSourceSet;)V - public final fun dependsOn (Lorg/jetbrains/dokka/DokkaSourceSetID;)V - public final fun dependsOn (Lorg/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilder;)V - public final fun externalDocumentationLink (Lgroovy/lang/Closure;)V - public final fun externalDocumentationLink (Ljava/lang/String;Ljava/lang/String;)V - public final fun externalDocumentationLink (Ljava/net/URL;Ljava/net/URL;)V - public final fun externalDocumentationLink (Lorg/gradle/api/Action;)V - public static synthetic fun externalDocumentationLink$default (Lorg/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilder;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)V - public static synthetic fun externalDocumentationLink$default (Lorg/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilder;Ljava/net/URL;Ljava/net/URL;ILjava/lang/Object;)V - public final fun getApiVersion ()Lorg/gradle/api/provider/Property; - public final fun getClasspath ()Lorg/gradle/api/file/ConfigurableFileCollection; - public final fun getDependentSourceSets ()Lorg/gradle/api/provider/SetProperty; - public final fun getDisplayName ()Lorg/gradle/api/provider/Property; - public final fun getDocumentedVisibilities ()Lorg/gradle/api/provider/SetProperty; - public final fun getExternalDocumentationLinks ()Lorg/gradle/api/provider/SetProperty; - public final fun getIncludeNonPublic ()Lorg/gradle/api/provider/Property; - public final fun getIncludes ()Lorg/gradle/api/file/ConfigurableFileCollection; - public final fun getJdkVersion ()Lorg/gradle/api/provider/Property; - public final fun getLanguageVersion ()Lorg/gradle/api/provider/Property; - public final fun getName ()Ljava/lang/String; - public final fun getNoAndroidSdkLink ()Lorg/gradle/api/provider/Property; - public final fun getNoJdkLink ()Lorg/gradle/api/provider/Property; - public final fun getNoStdlibLink ()Lorg/gradle/api/provider/Property; - public final fun getPerPackageOptions ()Lorg/gradle/api/provider/ListProperty; - public final fun getPlatform ()Lorg/gradle/api/provider/Property; - public final fun getReportUndocumented ()Lorg/gradle/api/provider/Property; - public final fun getSamples ()Lorg/gradle/api/file/ConfigurableFileCollection; - public final fun getSkipDeprecated ()Lorg/gradle/api/provider/Property; - public final fun getSkipEmptyPackages ()Lorg/gradle/api/provider/Property; - public final fun getSourceLinks ()Lorg/gradle/api/provider/SetProperty; - public final fun getSourceRoots ()Lorg/gradle/api/file/ConfigurableFileCollection; - public final fun getSourceSetID ()Lorg/jetbrains/dokka/DokkaSourceSetID; - public final fun getSuppress ()Lorg/gradle/api/provider/Property; - public final fun getSuppressGeneratedFiles ()Lorg/gradle/api/provider/Property; - public final fun getSuppressedFiles ()Lorg/gradle/api/file/ConfigurableFileCollection; - public final fun perPackageOption (Lgroovy/lang/Closure;)V - public final fun perPackageOption (Lorg/gradle/api/Action;)V - public final fun sourceLink (Lgroovy/lang/Closure;)V - public final fun sourceLink (Lorg/gradle/api/Action;)V - public final fun sourceRoot (Ljava/io/File;)V - public final fun sourceRoot (Ljava/lang/String;)V -} - -public final class org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilderExtensionsKt { - public static final fun dependsOn (Lorg/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilder;Lcom/android/build/api/dsl/AndroidSourceSet;)V - public static final fun dependsOn (Lorg/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilder;Lcom/android/build/gradle/api/AndroidSourceSet;)V - public static final fun dependsOn (Lorg/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilder;Lorg/jetbrains/kotlin/gradle/plugin/KotlinSourceSet;)V - public static final fun kotlinSourceSet (Lorg/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilder;Lorg/jetbrains/kotlin/gradle/plugin/KotlinSourceSet;)V -} - -public final class org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilderFactoryKt { - public static final fun gradleDokkaSourceSetBuilderFactory (Lorg/jetbrains/dokka/gradle/AbstractDokkaTask;)Lorg/gradle/api/NamedDomainObjectFactory; -} - -public final class org/jetbrains/dokka/gradle/GradleExternalDocumentationLinkBuilder : org/jetbrains/dokka/DokkaConfigurationBuilder { - public fun <init> (Lorg/gradle/api/Project;)V - public synthetic fun build ()Ljava/lang/Object; - public fun build ()Lorg/jetbrains/dokka/ExternalDocumentationLinkImpl; - public final fun getPackageListUrl ()Lorg/gradle/api/provider/Property; - public final fun getUrl ()Lorg/gradle/api/provider/Property; -} - -public final class org/jetbrains/dokka/gradle/GradlePackageOptionsBuilder : org/jetbrains/dokka/DokkaConfigurationBuilder { - public fun <init> (Lorg/gradle/api/Project;)V - public synthetic fun build ()Ljava/lang/Object; - public fun build ()Lorg/jetbrains/dokka/PackageOptionsImpl; - public final fun getDocumentedVisibilities ()Lorg/gradle/api/provider/SetProperty; - public final fun getIncludeNonPublic ()Lorg/gradle/api/provider/Property; - public final fun getMatchingRegex ()Lorg/gradle/api/provider/Property; - public final fun getReportUndocumented ()Lorg/gradle/api/provider/Property; - public final fun getSkipDeprecated ()Lorg/gradle/api/provider/Property; - public final fun getSuppress ()Lorg/gradle/api/provider/Property; -} - -public final class org/jetbrains/dokka/gradle/GradleSourceLinkBuilder : org/jetbrains/dokka/DokkaConfigurationBuilder { - public fun <init> (Lorg/gradle/api/Project;)V - public synthetic fun build ()Ljava/lang/Object; - public fun build ()Lorg/jetbrains/dokka/SourceLinkDefinitionImpl; - public final fun getLocalDirectory ()Lorg/gradle/api/provider/Property; - public final fun getRemoteLineSuffix ()Lorg/gradle/api/provider/Property; - public final fun getRemoteUrl ()Lorg/gradle/api/provider/Property; -} - -public final class org/jetbrains/dokka/gradle/SourceSetKotlinGistConfigurationKt { - public static final fun configureWithKotlinSourceSet (Lorg/je |
