Skip to content

Commit

Permalink
Add info about mavenLocal
Browse files Browse the repository at this point in the history
  • Loading branch information
whyoleg committed May 8, 2024
1 parent 605f753 commit 743358a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,10 +105,11 @@ However, if you need to run all integration tests locally, you can use the `inte
If you need to run a specific test locally, you can run it from your IDE or by calling the corresponding Gradle
task (for example, `:dokka-integration-tests:gradle:testExternalProjectKotlinxCoroutines`).

It's possible to run integration tests with a custom Dokka version published to
It's possible to run integration tests with a custom Dokka version published to
[MavenCentral](https://central.sonatype.com),
[dev](https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev) or
[test](https://maven.pkg.jetbrains.space/kotlin/p/dokka/test)
[dev](https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev),
[test](https://maven.pkg.jetbrains.space/kotlin/p/dokka/test) or
`mavenLocal` (in this case the version should contain `-local-` suffix, f.e `2.0.0-local-reproducing-bug`)
via `org.jetbrains.dokka.integration_test.dokkaVersionOverride` Gradle property:

```bash
Expand Down
5 changes: 3 additions & 2 deletions dokka-integration-tests/gradle/projects/ui-showcase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ export DOKKA_TEST_OUTPUT_PATH="build/ui-showcase-result"

Dokka should be published in one of the following repositories:
[MavenCentral](https://central.sonatype.com),
[dev](https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev) or
[test](https://maven.pkg.jetbrains.space/kotlin/p/dokka/test)
[dev](https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev),
[test](https://maven.pkg.jetbrains.space/kotlin/p/dokka/test) or
`mavenLocal` (in this case the version should contain `-local-` suffix, f.e `2.0.0-local-reproducing-bug`)

```bash
export DOKKA_TEST_OUTPUT_PATH="build/ui-showcase-result"
Expand Down

0 comments on commit 743358a

Please sign in to comment.