Skip to content

Commit f83d5f0

Browse files
authored
Update guide on how to run IT (#4230)
Fixes #4168
1 parent 26ff9c9 commit f83d5f0

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,10 +122,17 @@ Integration tests require a significant amount of available RAM (~20-30GB), take
122122
environment configuration to run. For these reasons, it's not expected that you run all integration tests locally
123123
as part of the everyday development process, they will be run on CI once you submit a PR.
124124

125-
However, if you need to run all integration tests locally, you can use the `integrationTest` task:
125+
Integration tests are executed by default when running `check`, `test` or `build` tasks.
126+
It's possible to skip those by passing `-Porg.jetbrains.dokka.integration_test.skip=true` to the Gradle command, like:
126127

127128
```bash
128-
./gradlew integrationTest
129+
./gradlew check -Porg.jetbrains.dokka.integration_test.skip=true
130+
```
131+
132+
Integration tests can be run explicitly by running `check` task in `:dokka-integration-tests` composite build:
133+
134+
```bash
135+
./gradlew :dokka-integration-tests:check
129136
```
130137

131138
If you need to run a specific test locally, you can run it from your IDE or by calling the corresponding Gradle

docs-developer/docs/developer_guide/workflow.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,10 +111,17 @@ Integration tests require a significant amount of available RAM (~20-30GB), take
111111
environment configuration to run. For these reasons, it's not expected that you run all integration tests locally
112112
as part of the everyday development process, they will be run on CI once you submit a PR.
113113

114-
However, if you need to run all integration tests locally, you can use the `integrationTest` task:
114+
Integration tests are executed by default when running `check`, `test` or `build` tasks.
115+
It's possible to skip those by passing `-Porg.jetbrains.dokka.integration_test.skip=true` to the Gradle command, like:
115116

116-
```shell
117-
./gradlew integrationTest
117+
```bash
118+
./gradlew check -Porg.jetbrains.dokka.integration_test.skip=true
119+
```
120+
121+
Integration tests can be run explicitly by running `check` task in `:dokka-integration-tests` composite build:
122+
123+
```bash
124+
./gradlew :dokka-integration-tests:check
118125
```
119126

120127
If you need to run a specific test locally, you can run it from your IDE or by calling the corresponding Gradle

0 commit comments

Comments
 (0)