Add a guide on how to sync Gradle integration tests in IDEA (#3654)

Kotlin · Jun 26, 2024 · 87f9cfc · 87f9cfc
1 parent 47e4e8d
commit 87f9cfc
Show file tree

Hide file tree

Showing 18 changed files with 84 additions and 16 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -116,6 116,9 @@ via `org.jetbrains.dokka.integration_test.dokkaVersionOverride` Gradle property:
 ./gradlew :dokka-integration-tests:gradle:testExternalProjectKotlinxCoroutines -Porg.jetbrains.dokka.integration_test.dokkaVersionOverride=2.0.0-dev-329
 ```
 
 Additionally, it's possible to open the Gradle integration test projects in IDEA.
 Instructions are located in [README.md of Gradle integration tests](dokka-integration-tests/gradle/projects/README.md). 
 
 ## Infrastructure
 
 ### Java version

diff --git a/dokka-integration-tests/gradle/projects/README.md b/dokka-integration-tests/gradle/projects/README.md
@@ -0,0 1,16 @@
 # Running integration tests projects locally
 
 Projects used to run integration tests could be opened in or build independently by following these steps:
 
 1. open `gradle.properties` file of a specific project and change commented variables:
  1. `dokka_it_kotlin_version` to required version of Kotlin Gradle Plugin, e.g 2.0.0
  2. `dokka_it_dokka_version` to required version to Dokka Gradle plugin, e.g 1.9.20
  3. replace all other commented properties if needed, like `dokka_it_android_gradle_plugin_version`
 2. open `settings.gradle.kts` and replace `apply(from = "template.settings.gradle.kts")` with
  `apply(from = "../template.settings.gradle.kts")` (so the path should be prefixed with `../`)
 3. (Optional) replace `/* %{DOKKA_IT_MAVEN_REPO}% */` with custom maven repositories like `mavenLocal` in
  `template.settings.gradle.kts` if dependencies should be resolved from places other than Maven Central.
 4. Now it's possible to link a project in IDEA by right-clicking on `settings.gradle.kts` of a project and selecting
  `Link Gradle Project`
 
 Note: for `ui-showcase` project those 1 and 2 steps should be done for both root of the project and `build-logic`.
diff --git a/dokka-integration-tests/gradle/projects/it-android-0/gradle.properties b/dokka-integration-tests/gradle/projects/it-android-0/gradle.properties
@@ -2,6 2,9 @@
 # Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 #
 
-dokka_it_kotlin_version=2.0.0
-dokka_it_android_gradle_plugin_version=4.2.2
 android.useAndroidX=true
 
 # to sync the project locally, check dokka-integration-tests/gradle/projects/README.md
 #dokka_it_kotlin_version=
 #dokka_it_dokka_version=
 #dokka_it_android_gradle_plugin_version=
diff --git a/dokka-integration-tests/gradle/projects/it-basic-groovy/gradle.properties b/dokka-integration-tests/gradle/projects/it-basic-groovy/gradle.properties
@@ -2,4 2,6 @@
 # Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 #
 
-dokka_it_kotlin_version=2.0.0
 # to sync the project locally, check dokka-integration-tests/gradle/projects/README.md
 #dokka_it_kotlin_version=
 #dokka_it_dokka_version=
diff --git a/dokka-integration-tests/gradle/projects/it-basic/gradle.properties b/dokka-integration-tests/gradle/projects/it-basic/gradle.properties
@@ -2,4 2,6 @@
 # Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 #
 
-dokka_it_kotlin_version=2.0.0
 # to sync the project locally, check dokka-integration-tests/gradle/projects/README.md
 #dokka_it_kotlin_version=
 #dokka_it_dokka_version=
diff --git a/dokka-integration-tests/gradle/projects/it-collector-0/gradle.properties b/dokka-integration-tests/gradle/projects/it-collector-0/gradle.properties
@@ -2,4 2,6 @@
 # Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 #
 
-dokka_it_kotlin_version=2.0.0
 # to sync the project locally, check dokka-integration-tests/gradle/projects/README.md
 #dokka_it_kotlin_version=
 #dokka_it_dokka_version=
diff --git a/dokka-integration-tests/gradle/projects/it-configuration/gradle.properties b/dokka-integration-tests/gradle/projects/it-configuration/gradle.properties
@@ -2,6 2,9 @@
 # Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 #
 
-dokka_it_kotlin_version=2.0.0
 fail_on_warning=false
 report_undocumented=false
 
 # to sync the project locally, check dokka-integration-tests/gradle/projects/README.md
 #dokka_it_kotlin_version=
 #dokka_it_dokka_version=
diff --git a/dokka-integration-tests/gradle/projects/it-js-ir-0/gradle.properties b/dokka-integration-tests/gradle/projects/it-js-ir-0/gradle.properties
@@ -2,5 2,7 @@
 # Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 #
 
-dokka_it_kotlin_version=2.0.0
-react_version=18.2.0-pre.467
 # to sync the project locally, check dokka-integration-tests/gradle/projects/README.md
 #dokka_it_kotlin_version=
 #dokka_it_dokka_version=
 #react_version=
diff --git a/dokka-integration-tests/gradle/projects/it-multimodule-0/gradle.properties b/dokka-integration-tests/gradle/projects/it-multimodule-0/gradle.properties
@@ -2,4 2,6 @@
 # Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 #
 
-dokka_it_kotlin_version=2.0.0
 # to sync the project locally, check dokka-integration-tests/gradle/projects/README.md
 #dokka_it_kotlin_version=
 #dokka_it_dokka_version=
diff --git a/dokka-integration-tests/gradle/projects/it-multimodule-1/gradle.properties b/dokka-integration-tests/gradle/projects/it-multimodule-1/gradle.properties
@@ -2,4 2,6 @@
 # Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 #
 
-dokka_it_kotlin_version=2.0.0
 # to sync the project locally, check dokka-integration-tests/gradle/projects/README.md
 #dokka_it_kotlin_version=
 #dokka_it_dokka_version=
diff --git a/dokka-integration-tests/gradle/projects/it-multimodule-inter-module-links/gradle.properties b/dokka-integration-tests/gradle/projects/it-multimodule-inter-module-links/gradle.properties
@@ -2,4 2,6 @@
 # Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 #
 
-dokka_it_kotlin_version=2.0.0
 # to sync the project locally, check dokka-integration-tests/gradle/projects/README.md
 #dokka_it_kotlin_version=
 #dokka_it_dokka_version=
diff --git a/dokka-integration-tests/gradle/projects/it-multimodule-versioning-0/gradle.properties b/dokka-integration-tests/gradle/projects/it-multimodule-versioning-0/gradle.properties
@@ -2,5 2,6 @@
 # Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 #
 
-dokka_it_kotlin_version=2.0.0
-
 # to sync the project locally, check dokka-integration-tests/gradle/projects/README.md
 #dokka_it_kotlin_version=
 #dokka_it_dokka_version=
diff --git a/dokka-integration-tests/gradle/projects/it-multiplatform-0/gradle.properties b/dokka-integration-tests/gradle/projects/it-multiplatform-0/gradle.properties
@@ -2,4 2,6 @@
 # Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 #
 
-dokka_it_kotlin_version=2.0.0
 # to sync the project locally, check dokka-integration-tests/gradle/projects/README.md
 #dokka_it_kotlin_version=
 #dokka_it_dokka_version=
diff --git a/...-integration-tests/gradle/projects/it-sequential-tasks-execution-stress/gradle.properties b/...-integration-tests/gradle/projects/it-sequential-tasks-execution-stress/gradle.properties
@@ -2,5 2,8 @@
 # Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 #
 
-dokka_it_kotlin_version=2.0.0
 task_number=100
 
 # to sync the project locally, check dokka-integration-tests/gradle/projects/README.md
 #dokka_it_kotlin_version=
 #dokka_it_dokka_version=
diff --git a/dokka-integration-tests/gradle/projects/it-wasm-basic/gradle.properties b/dokka-integration-tests/gradle/projects/it-wasm-basic/gradle.properties
@@ -0,0 1,7 @@
 #
 # Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 #
 
 # to sync the project locally, check dokka-integration-tests/gradle/projects/README.md
 #dokka_it_kotlin_version=
 #dokka_it_dokka_version=
diff --git a/dokka-integration-tests/gradle/projects/it-wasm-js-wasi-basic/gradle.properties b/dokka-integration-tests/gradle/projects/it-wasm-js-wasi-basic/gradle.properties
@@ -2,4 2,6 @@
 # Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 #
 
-dokka_it_kotlin_version=2.0.0
 # to sync the project locally, check dokka-integration-tests/gradle/projects/README.md
 #dokka_it_kotlin_version=
 #dokka_it_dokka_version=
diff --git a/dokka-integration-tests/gradle/projects/ui-showcase/build-logic/gradle.properties b/dokka-integration-tests/gradle/projects/ui-showcase/build-logic/gradle.properties
@@ -0,0 1,7 @@
 #
 # Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 #
 
 # to sync the project locally, check dokka-integration-tests/gradle/projects/README.md
 #dokka_it_kotlin_version=
 #dokka_it_dokka_version=
diff --git a/dokka-integration-tests/gradle/projects/ui-showcase/gradle.properties b/dokka-integration-tests/gradle/projects/ui-showcase/gradle.properties
@@ -0,0 1,7 @@
 #
 # Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 #
 
 # to sync the project locally, check dokka-integration-tests/gradle/projects/README.md
 #dokka_it_kotlin_version=
 #dokka_it_dokka_version=