From 0b2d4da7546337c01ff3500c463e17896acf24d7 Mon Sep 17 00:00:00 2001 From: IgnatBeresnev Date: Fri, 1 Sep 2023 15:07:32 +0200 Subject: [PATCH 1/2] Update Dokka's references to 1.9.0 --- CONTRIBUTING.md | 12 ++++----- README.md | 14 +++++----- .../src/doc/docs/developer_guide/workflow.md | 4 +-- .../build.gradle.kts | 4 +-- .../dokka-gradle-example/build.gradle.kts | 2 +- .../build.gradle.kts | 8 +++--- .../build.gradle.kts | 2 +- .../gradle.properties | 2 +- .../build.gradle.kts | 2 +- .../build.gradle.kts | 4 +-- .../parentProject/build.gradle.kts | 2 +- examples/maven/pom.xml | 2 +- examples/plugin/hide-internal-api/README.md | 4 +-- .../plugin/hide-internal-api/build.gradle.kts | 2 +- .../hide-internal-api/gradle.properties | 2 +- gradle/libs.versions.toml | 2 +- .../gradle/projects/it-basic/build.gradle.kts | 2 +- .../it-configuration/build.gradle.kts | 2 +- .../it/gradle/BasicGradleIntegrationTest.kt | 2 +- plugins/kotlin-as-java/README.md | 2 +- plugins/mathjax/README.md | 2 +- plugins/versioning/README.md | 26 +++++++++---------- 22 files changed, 52 insertions(+), 52 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cc618be4c7..f5b60bc1de 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,9 +23,9 @@ Bug reports, feature requests and questions are welcome. Submit issues [here](ht ## Submitting PRs -Dokka has extensive [Developer Guides](https://kotlin.github.io/dokka/1.8.20/developer_guide/introduction/) documentation -which goes over the development [Workflow](https://kotlin.github.io/dokka/1.8.20/developer_guide/workflow/) and -[Dokka's architecture](https://kotlin.github.io/dokka/1.8.20/developer_guide/architecture/architecture_overview/), +Dokka has extensive [Developer Guides](https://kotlin.github.io/dokka/1.9.0/developer_guide/introduction/) documentation +which goes over the development [Workflow](https://kotlin.github.io/dokka/1.9.0/developer_guide/workflow/) and +[Dokka's architecture](https://kotlin.github.io/dokka/1.9.0/developer_guide/architecture/architecture_overview/), which can help you understand how to achieve what you want and where to look. All development (both new features and bugfixes) takes place in the `master` branch, it contains sources for the next @@ -61,10 +61,10 @@ Unit tests which are run as part of `build` should not take much time, but you c ### Use/test locally built Dokka Below you will find a bare-bones instruction on how to use and test locally built Dokka. For more details and examples, -visit [Workflow](https://kotlin.github.io/dokka/1.8.20/developer_guide/workflow/) topic. +visit [Workflow](https://kotlin.github.io/dokka/1.9.0/developer_guide/workflow/) topic. 1. Change `dokka_version` in `gradle.properties` to something that you will use later on as the dependency version. - For instance, you can set it to something like `1.8.20-my-fix-SNAPSHOT`. + For instance, you can set it to something like `1.9.0-my-fix-SNAPSHOT`. 2. Publish it to Maven Local (`./gradlew publishToMavenLocal`) 3. In the project for which you want to generate documentation add Maven Local as a buildscript/dependency repository (`mavenLocal()`) @@ -72,7 +72,7 @@ visit [Workflow](https://kotlin.github.io/dokka/1.8.20/developer_guide/workflow/ ```kotlin plugins { - id("org.jetbrains.dokka") version "1.8.20-my-fix-SNAPSHOT" + id("org.jetbrains.dokka") version "1.9.0-my-fix-SNAPSHOT" } ``` diff --git a/README.md b/README.md index 92f911b4b5..ff16e45d52 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ Apply the Gradle plugin for Dokka in the root build script of your project: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.8.20" + id("org.jetbrains.dokka") version "1.9.0" } ``` @@ -65,7 +65,7 @@ Apply Gradle plugin for Dokka in the root project: ```groovy plugins { - id 'org.jetbrains.dokka' version '1.8.20' + id 'org.jetbrains.dokka' version '1.9.0' } ``` @@ -99,7 +99,7 @@ Add the Dokka Maven plugin to the `plugins` section of your POM file: org.jetbrains.dokka dokka-maven-plugin - 1.8.20 + 1.9.0 pre-site @@ -138,7 +138,7 @@ Android platform: ```kotlin dependencies { - dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.8.20") + dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.9.0") } ``` @@ -149,7 +149,7 @@ dependencies { ```groovy dependencies { - dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.8.20' + dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.9.0' } ``` @@ -168,7 +168,7 @@ dependencies { org.jetbrains.dokka android-documentation-plugin - 1.8.20 + 1.9.0 @@ -215,7 +215,7 @@ implement plugins for missing or very specific features that are not provided ou Learn more about Dokka plugins and their configuration in [Dokka plugins](https://kotlinlang.org/docs/dokka-plugins.html). If you want to learn how to develop Dokka plugins, see -[Developer guides](https://kotlin.github.io/dokka/1.8.20/developer_guide/introduction/). +[Developer guides](https://kotlin.github.io/dokka/1.9.0/developer_guide/introduction/). ## Community diff --git a/docs-developer/src/doc/docs/developer_guide/workflow.md b/docs-developer/src/doc/docs/developer_guide/workflow.md index 7db5382df7..26452281bb 100644 --- a/docs-developer/src/doc/docs/developer_guide/workflow.md +++ b/docs-developer/src/doc/docs/developer_guide/workflow.md @@ -42,7 +42,7 @@ Having built Dokka locally, you can publish it to `mavenLocal()`. This will allo project as well as debug code remotely. 1. Change `dokka_version` in `gradle.properties` to something that you will use later on as the dependency version. - For instance, you can set it to something like `1.8.20-my-fix-SNAPSHOT`. This version will be propagated to plugins + For instance, you can set it to something like `1.9.0-my-fix-SNAPSHOT`. This version will be propagated to plugins that reside inside Dokka's project (such as `mathjax`, `kotlin-as-java`, etc). 2. Publish it to Maven Local (`./gradlew publishToMavenLocal`). Corresponding artifacts should appear in `~/.m2` 3. In the project you want to generate documentation for or debug on, add maven local as a plugin/dependency @@ -55,7 +55,7 @@ repositories { 4. Update your Dokka dependency to the version you've just published: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.8.20-my-fix-SNAPSHOT" + id("org.jetbrains.dokka") version "1.9.0-my-fix-SNAPSHOT" } ``` diff --git a/examples/gradle/dokka-customFormat-example/build.gradle.kts b/examples/gradle/dokka-customFormat-example/build.gradle.kts index ba6d1cb6c7..280b8edbd0 100644 --- a/examples/gradle/dokka-customFormat-example/build.gradle.kts +++ b/examples/gradle/dokka-customFormat-example/build.gradle.kts @@ -8,12 +8,12 @@ import org.jetbrains.dokka.base.DokkaBaseConfiguration plugins { kotlin("jvm") version "1.9.0" - id("org.jetbrains.dokka") version "1.8.20" + id("org.jetbrains.dokka") version "1.9.0" } buildscript { dependencies { - classpath("org.jetbrains.dokka:dokka-base:1.8.20") + classpath("org.jetbrains.dokka:dokka-base:1.9.0") } } diff --git a/examples/gradle/dokka-gradle-example/build.gradle.kts b/examples/gradle/dokka-gradle-example/build.gradle.kts index 67d3007bf5..0d09f96fe8 100644 --- a/examples/gradle/dokka-gradle-example/build.gradle.kts +++ b/examples/gradle/dokka-gradle-example/build.gradle.kts @@ -7,7 +7,7 @@ import java.net.URL plugins { kotlin("jvm") version "1.9.0" - id("org.jetbrains.dokka") version "1.8.20" + id("org.jetbrains.dokka") version "1.9.0" } repositories { diff --git a/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts b/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts index 62cec64d1f..f971188355 100644 --- a/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts +++ b/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts @@ -4,7 +4,7 @@ plugins { kotlin("jvm") version "1.9.0" - id("org.jetbrains.dokka") version "1.8.20" + id("org.jetbrains.dokka") version "1.9.0" } repositories { @@ -15,11 +15,11 @@ dependencies { testImplementation(kotlin("test-junit")) // Will apply the plugin to all Dokka tasks - dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.20") + dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.0") // Will apply the plugin only to the `:dokkaHtml` task - //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.20") + //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.0") // Will apply the plugin only to the `:dokkaGfm` task - //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.20") + //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.0") } diff --git a/examples/gradle/dokka-library-publishing-example/build.gradle.kts b/examples/gradle/dokka-library-publishing-example/build.gradle.kts index d6fa25f752..003aa04f46 100644 --- a/examples/gradle/dokka-library-publishing-example/build.gradle.kts +++ b/examples/gradle/dokka-library-publishing-example/build.gradle.kts @@ -4,7 +4,7 @@ plugins { kotlin("jvm") version "1.9.0" - id("org.jetbrains.dokka") version "1.8.20" + id("org.jetbrains.dokka") version "1.9.0" `java-library` `maven-publish` } diff --git a/examples/gradle/dokka-multimodule-example/gradle.properties b/examples/gradle/dokka-multimodule-example/gradle.properties index fac57ddd79..fda31413f2 100644 --- a/examples/gradle/dokka-multimodule-example/gradle.properties +++ b/examples/gradle/dokka-multimodule-example/gradle.properties @@ -3,4 +3,4 @@ # kotlinVersion=1.9.0 -dokkaVersion=1.8.20 +dokkaVersion=1.9.0 diff --git a/examples/gradle/dokka-multiplatform-example/build.gradle.kts b/examples/gradle/dokka-multiplatform-example/build.gradle.kts index 33e20f3a99..56c03564c4 100644 --- a/examples/gradle/dokka-multiplatform-example/build.gradle.kts +++ b/examples/gradle/dokka-multiplatform-example/build.gradle.kts @@ -9,7 +9,7 @@ import org.jetbrains.dokka.Platform plugins { kotlin("multiplatform") version "1.9.0" - id("org.jetbrains.dokka") version "1.8.20" + id("org.jetbrains.dokka") version "1.9.0" } repositories { diff --git a/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts b/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts index 44b0b7575f..3984caa598 100644 --- a/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts +++ b/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts @@ -4,7 +4,7 @@ plugins { kotlin("jvm") version "1.9.0" - id("org.jetbrains.dokka") version "1.8.20" apply false + id("org.jetbrains.dokka") version "1.9.0" apply false } // The versioning plugin must be applied in all submodules @@ -18,6 +18,6 @@ subprojects { } val dokkaPlugin by configurations dependencies { - dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.8.20") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.9.0") } } diff --git a/examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts b/examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts index 2cca327415..4bcee1609d 100644 --- a/examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts +++ b/examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts @@ -8,7 +8,7 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration buildscript { dependencies { - classpath("org.jetbrains.dokka:versioning-plugin:1.8.20") + classpath("org.jetbrains.dokka:versioning-plugin:1.9.0") } repositories { diff --git a/examples/maven/pom.xml b/examples/maven/pom.xml index 66e42847f1..811e490236 100644 --- a/examples/maven/pom.xml +++ b/examples/maven/pom.xml @@ -13,7 +13,7 @@ 1.0-SNAPSHOT 1.9.0 - 1.8.20 + 1.9.0 diff --git a/examples/plugin/hide-internal-api/README.md b/examples/plugin/hide-internal-api/README.md index 451303cb48..f186d2e0c9 100644 --- a/examples/plugin/hide-internal-api/README.md +++ b/examples/plugin/hide-internal-api/README.md @@ -1,7 +1,7 @@ # Hide Internal API plugin example This project represents a simple Dokka Plugin that was developed step-by-step in the -[Sample plugin](https://kotlin.github.io/dokka/1.8.20/developer_guide/plugin-development/sample-plugin-tutorial/) +[Sample plugin](https://kotlin.github.io/dokka/1.9.0/developer_guide/plugin-development/sample-plugin-tutorial/) tutorial. This is a frequent request with varying requirements. The plugin excludes any declaration that is marked with `org.jetbrains.dokka.internal.test.Internal` annotation. @@ -9,7 +9,7 @@ The annotation itself is not provided in this project and is instead matched by You can change it to your own internal annotation or to some other marker that suits you. To learn how to install and debug it locally, -[see documentation](https://kotlin.github.io/dokka/1.8.20/developer_guide/plugin-development/sample-plugin-tutorial/#debugging). +[see documentation](https://kotlin.github.io/dokka/1.9.0/developer_guide/plugin-development/sample-plugin-tutorial/#debugging). ___ diff --git a/examples/plugin/hide-internal-api/build.gradle.kts b/examples/plugin/hide-internal-api/build.gradle.kts index 2d167a1784..bdbf365814 100644 --- a/examples/plugin/hide-internal-api/build.gradle.kts +++ b/examples/plugin/hide-internal-api/build.gradle.kts @@ -8,7 +8,7 @@ import java.net.URI plugins { kotlin("jvm") version "1.9.0" - id("org.jetbrains.dokka") version "1.8.20" + id("org.jetbrains.dokka") version "1.9.0" `maven-publish` signing } diff --git a/examples/plugin/hide-internal-api/gradle.properties b/examples/plugin/hide-internal-api/gradle.properties index bee9d785d8..40669a3870 100644 --- a/examples/plugin/hide-internal-api/gradle.properties +++ b/examples/plugin/hide-internal-api/gradle.properties @@ -2,4 +2,4 @@ # Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. # -dokkaVersion=1.8.20 +dokkaVersion=1.9.0 diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 815c479ea4..7b650cf5f6 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -3,7 +3,7 @@ gradlePlugin-kotlin = "1.9.0" # See: https://kotlinlang.org/docs/gradle-configure-project.html#apply-the-plugin gradlePlugin-android = "4.2.2" -gradlePlugin-dokka = "1.8.20" +gradlePlugin-dokka = "1.9.0" kotlinx-coroutines = "1.6.3" kotlinx-collections-immutable = "0.3.4" diff --git a/integration-tests/gradle/projects/it-basic/build.gradle.kts b/integration-tests/gradle/projects/it-basic/build.gradle.kts index 2528714d19..4ec3b82500 100644 --- a/integration-tests/gradle/projects/it-basic/build.gradle.kts +++ b/integration-tests/gradle/projects/it-basic/build.gradle.kts @@ -20,7 +20,7 @@ buildscript { } } -version = "1.8.20-SNAPSHOT" +version = "1.9.0-SNAPSHOT" apply(from = "../template.root.gradle.kts") diff --git a/integration-tests/gradle/projects/it-configuration/build.gradle.kts b/integration-tests/gradle/projects/it-configuration/build.gradle.kts index 3b4a7658d0..02e99e9b44 100644 --- a/integration-tests/gradle/projects/it-configuration/build.gradle.kts +++ b/integration-tests/gradle/projects/it-configuration/build.gradle.kts @@ -16,7 +16,7 @@ buildscript { } } -version = "1.8.20-SNAPSHOT" +version = "1.9.0-SNAPSHOT" apply(from = "../template.root.gradle.kts") diff --git a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt index 0256f5939b..f214710caf 100644 --- a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt +++ b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt @@ -158,7 +158,7 @@ class BasicGradleIntegrationTest : AbstractGradleIntegrationTest() { val indexFile = File(this, "index.html") assertTrue(indexFile.isFile, "Missing index.html") assertTrue( - """Basic Project 1.8.20-SNAPSHOT API """ in indexFile.readText(), + """Basic Project 1.9.0-SNAPSHOT API """ in indexFile.readText(), "Header with version number not present in index.html" ) diff --git a/plugins/kotlin-as-java/README.md b/plugins/kotlin-as-java/README.md index 40d33e685e..b0ec7c8e98 100644 --- a/plugins/kotlin-as-java/README.md +++ b/plugins/kotlin-as-java/README.md @@ -8,7 +8,7 @@ The Kotlin as Java plugin is published to maven central as a [separate artifact](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-as-java-plugin): ```text -org.jetbrains.dokka:kotlin-as-java-plugin:1.8.20 +org.jetbrains.dokka:kotlin-as-java-plugin:1.9.0 ``` **This plugin is at its early stages**, so you may experience issues and encounter bugs. Feel free to diff --git a/plugins/mathjax/README.md b/plugins/mathjax/README.md index 985b975d0e..d9604084b5 100644 --- a/plugins/mathjax/README.md +++ b/plugins/mathjax/README.md @@ -23,5 +23,5 @@ The MathJax plugin is published to Maven Central as a [separate artifact](https://mvnrepository.com/artifact/org.jetbrains.dokka/mathjax-plugin): ```text -org.jetbrains.dokka:mathjax-plugin:1.8.20 +org.jetbrains.dokka:mathjax-plugin:1.9.0 ``` diff --git a/plugins/versioning/README.md b/plugins/versioning/README.md index 58517bbb56..be36ef0ee7 100644 --- a/plugins/versioning/README.md +++ b/plugins/versioning/README.md @@ -19,7 +19,7 @@ You can apply the versioning plugin the same way as other Dokka plugins: ```kotlin dependencies { - dokkaHtmlPlugin("org.jetbrains.dokka:versioning-plugin:1.8.20") + dokkaHtmlPlugin("org.jetbrains.dokka:versioning-plugin:1.9.0") } ``` @@ -33,7 +33,7 @@ plugin within subprojects as well as in their parent project. ```groovy dependencies { - dokkaHtmlPlugin 'org.jetbrains.dokka:versioning-plugin:1.8.20' + dokkaHtmlPlugin 'org.jetbrains.dokka:versioning-plugin:1.9.0' } ``` @@ -55,7 +55,7 @@ plugin within subprojects as well as in their parent project. org.jetbrains.dokka versioning-plugin - 1.8.20 + 1.9.0 @@ -68,15 +68,15 @@ plugin within subprojects as well as in their parent project. CLI You can find the versioning plugin's artifact on -[mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/versioning-plugin/1.8.20) or by browsing -[maven central repository](https://repo1.maven.org/maven2/org/jetbrains/dokka/versioning-plugin/1.8.20) +[mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/versioning-plugin/1.9.0) or by browsing +[maven central repository](https://repo1.maven.org/maven2/org/jetbrains/dokka/versioning-plugin/1.9.0) directly, and pass it to `pluginsClasspath`. Via command line arguments: ```Bash -java -jar dokka-cli-1.8.20.jar \ - -pluginsClasspath "./dokka-base-1.8.20.jar;...;./versioning-plugin-1.8.20.jar" \ +java -jar dokka-cli-1.9.0.jar \ + -pluginsClasspath "./dokka-base-1.9.0.jar;...;./versioning-plugin-1.9.0.jar" \ ... ``` @@ -86,9 +86,9 @@ Via JSON configuration: { ... "pluginsClasspath": [ - "./dokka-base-1.8.20.jar", + "./dokka-base-1.9.0.jar", "...", - "./versioning-plugin-1.8.20.jar" + "./versioning-plugin-1.9.0.jar" ], ... } @@ -135,7 +135,7 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration buildscript { dependencies { - classpath("org.jetbrains.dokka:versioning-plugin:1.8.20") + classpath("org.jetbrains.dokka:versioning-plugin:1.9.0") } } @@ -232,7 +232,7 @@ dokkaHtml { CLI ```Bash -java -jar dokka-cli-1.8.20.jar \ +java -jar dokka-cli-1.9.0.jar \ ... -pluginsConfiguration "org.jetbrains.dokka.versioning.VersioningPlugin={\"version\": \"1.5\", \"versionsOrdering\": [\"1.5\", \"1.4\", \"1.3\", \"1.2\", \"1.1\", \"alpha-2\", \"alpha-1\"], \"olderVersionsDir\": \"documentation/version\", \"olderVersions\": [\"documentation/alpha/alpha-2\", \"documentation/alpha/alpha-1\"], \"renderVersionsNavigationOnAllPages\": true}" @@ -290,12 +290,12 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration buildscript { dependencies { - classpath("org.jetbrains.dokka:versioning-plugin:1.8.20") + classpath("org.jetbrains.dokka:versioning-plugin:1.9.0") } } dependencies { - dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.8.20") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.9.0") } tasks.dokkaHtml { From ecdec36878a57091e9ef9504bab49e1df3b61d1e Mon Sep 17 00:00:00 2001 From: IgnatBeresnev Date: Fri, 1 Sep 2023 16:17:22 +0200 Subject: [PATCH 2/2] Update the versions in user-facing documentation --- docs/v.list | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/v.list b/docs/v.list index e9005e79a4..c17d5c7fbf 100644 --- a/docs/v.list +++ b/docs/v.list @@ -4,9 +4,9 @@