aboutsummaryrefslogtreecommitdiff
path: root/integration-tests/gradle/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'integration-tests/gradle/README.md')
-rw-r--r--integration-tests/gradle/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/integration-tests/gradle/README.md b/integration-tests/gradle/README.md
index 45828092..706cfb61 100644
--- a/integration-tests/gradle/README.md
+++ b/integration-tests/gradle/README.md
@@ -5,3 +5,17 @@ build.gradle.kts file -> "import gradle project".
Before importing: Make sure that you have dokka installed
locally (`./gradlew publishToMavenLocal`).
+
+### To update git submodules
+
+Integration tests have fixed git revision number, with the diff patch applied from the corresponding file (e.g. [`coroutines.diff`](projects/coroutines/coroutines.diff)).
+
+In order to update:
+
+* Checkout the project with the requered revision
+ - It's some state of the `master`
+* Manually write the diff (or apply the existing one and tweak) to have the project buildable against locally published Dokka of version `for-integration-tests-SNAPSHOT`
+* `git diff > $pathToProjectInDokka/project.diff`
+* Go to `$pathToProjectInDokka`, `git fetch && git checkout $revisionNumber`
+ - Prior to that, ensure that you have your git submodules initialized
+* Ensure that the corresponding `GradleIntegrationTest` passes locally and push