Merge branch 'master' of https://github.com/Kotlin/dokka into vmishen…

…ev/3702-reproducer

.gitattributes

@@ -1,4 +1,54 @@
+# https://help.github.com/articles/dealing-with-line-endings/
+# https://github.com/alexkaratarakis/gitattributes
+
 * text=auto eol=lf
+# The above will handle all files NOT found below
+
+*.json            text
+*.toml            text
+*.xml             text
+*.yaml            text
+*.yml             text
+.editorconfig     text
+.env              text
+
+# Documentation
+*.md              text diff=markdown
+*.txt             text
+
+# JVM
+*.java          text diff=java
+*.kt            text diff=kotlin
+*.kts           text diff=kotlin
+*.properties    text
+*.jar           binary
+
+
+# Linux start script should use lf
+gradlew         text eol=lf
+*.bash          text eol=lf
+*.sh            text eol=lf
+
+# These are Windows script files and should use crlf
+*.bat             text eol=crlf
+*.cmd             text eol=crlf
+
+# SVG treated as an asset (binary) by default.
+*.svg             text
+
+# Exclude external libs from GitHub language stats https://github.com/github/linguist/blob/v8.0.0/docs/overrides.md
+docs/**                                                             linguist-documentation
+docs-developer/**                                                   linguist-documentation
+examples/**                                                         linguist-documentation
+dokka-integration-tests/gradle/projects/**                          linguist-documentation
+
+# exclude test data
+dokka-integration-tests/gradle/projects/**/expectedData/**                                linguist-generated
+dokka-integration-tests/gradle/src/testExampleProjects/expectedData/**                    linguist-generated
+dokka-runners/dokka-gradle-plugin/src/testFunctional/resources/KotlinDslAccessorsTest/**  linguist-generated
 
-gradlew binary
-gradlew.bat binary
+# Tell Git not to export certain files or directories when generating an archive.
+# Since an archive doesn't contain git data, also exclude git metadata files.
+.gitattributes export-ignore
+.gitignore     export-ignore
+.gitkeep       export-ignore

.github/workflows/check-api.yml

@@ -16,7 +16,7 @@ jobs:
         with:
           distribution: 'zulu'
           java-version: 17
-      - uses: gradle/actions/setup-gradle@v3
+      - uses: gradle/actions/setup-gradle@v4
         with:
-          gradle-home-cache-cleanup: true
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
       - run: ./gradlew apiCheck --stacktrace

.github/workflows/examples-build.yml

@@ -35,9 +35,9 @@ jobs:
         with:
           distribution: 'zulu'
           java-version: 17
-      - uses: gradle/actions/setup-gradle@v3
+      - uses: gradle/actions/setup-gradle@v4
         with:
-          gradle-home-cache-cleanup: true
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
       - run: ./gradlew build --no-daemon --stacktrace
         working-directory: ${{ matrix.projects }}
         if: steps.filter.outputs.examples_changed == 'true'
@@ -65,9 +65,9 @@ jobs:
         with:
           distribution: 'zulu'
           java-version: 17
-      - uses: gradle/actions/setup-gradle@v3
+      - uses: gradle/actions/setup-gradle@v4
         with:
-          gradle-home-cache-cleanup: true
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
       - run: ./gradlew dokkaHtml --no-daemon --stacktrace
         working-directory: ${{ matrix.projects }}
         if: steps.filter.outputs.examples_changed == 'true'
@@ -89,9 +89,9 @@ jobs:
         with:
           distribution: 'zulu'
           java-version: 17
-      - uses: gradle/actions/setup-gradle@v3
+      - uses: gradle/actions/setup-gradle@v4
         with:
-          gradle-home-cache-cleanup: true
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
       - run: ./gradlew ${{ matrix.tasks }} --no-daemon --stacktrace
         working-directory: examples/gradle/dokka-library-publishing-example
         if: steps.filter.outputs.examples_changed == 'true'
@@ -115,9 +115,9 @@ jobs:
         with:
           distribution: 'zulu'
           java-version: 17
-      - uses: gradle/actions/setup-gradle@v3
+      - uses: gradle/actions/setup-gradle@v4
         with:
-          gradle-home-cache-cleanup: true
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
       - run: ./gradlew ${{ matrix.task }} --no-daemon --stacktrace
         working-directory: ${{ matrix.dir }}
         if: steps.filter.outputs.examples_changed == 'true'

.github/workflows/gh-pages-deploy-dev-docs.yml

@@ -22,9 +22,9 @@ jobs:
         with:
           distribution: 'zulu'
           java-version: 17
-      - uses: gradle/actions/setup-gradle@v3
+      - uses: gradle/actions/setup-gradle@v4
         with:
-          gradle-home-cache-cleanup: true
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
       - name: Get current Dokka version
         run: echo "DOKKA_VERSION=`./gradlew :properties | grep '^version:.*' | cut -d ' ' -f 2`" >> $GITHUB_ENV
         working-directory: ./dokka

.github/workflows/gh-pages-deploy-examples.yml

@@ -32,9 +32,9 @@ jobs:
         with:
           distribution: 'zulu'
           java-version: 17
-      - uses: gradle/actions/setup-gradle@v3
+      - uses: gradle/actions/setup-gradle@v4
         with:
-          gradle-home-cache-cleanup: true
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
       - name: Build html
         run: ./gradlew dokkaHtml --no-daemon --stacktrace
         working-directory: examples/gradle/${{ matrix.projects }}
@@ -68,9 +68,9 @@ jobs:
           distribution: 'zulu'
           java-version: 17
           cache: 'maven'
-      - uses: gradle/actions/setup-gradle@v3
+      - uses: gradle/actions/setup-gradle@v4
         with:
-          gradle-home-cache-cleanup: true
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
       - name: Build html
         run: ./gradlew dokkaHtmlMultiModule --no-daemon --stacktrace
         working-directory: examples/gradle/${{ matrix.projects }}

.github/workflows/preview-publish-ga.yml

@@ -20,9 +20,9 @@ jobs:
         with:
           distribution: 'zulu'
           java-version: 17
-      - uses: gradle/actions/setup-gradle@v3
+      - uses: gradle/actions/setup-gradle@v4
         with:
-          gradle-home-cache-cleanup: true
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
       - name: Document coroutines
         run: ./gradlew :dokka-integration-tests:gradle:testExternalProjectKotlinxCoroutines --stacktrace "-Dorg.gradle.jvmargs=-Xmx2g -XX:MaxMetaspaceSize=500m"
         env:
@@ -46,9 +46,9 @@ jobs:
         with:
           distribution: 'zulu'
           java-version: 17
-      - uses: gradle/actions/setup-gradle@v3
+      - uses: gradle/actions/setup-gradle@v4
         with:
-          gradle-home-cache-cleanup: true
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
       - name: Document serialization
         run: ./gradlew :dokka-integration-tests:gradle:testExternalProjectKotlinxSerialization --stacktrace "-Dorg.gradle.jvmargs=-Xmx2g -XX:MaxMetaspaceSize=500m"
         env:
@@ -72,9 +72,9 @@ jobs:
         with:
           distribution: 'zulu'
           java-version: 17
-      - uses: gradle/actions/setup-gradle@v3
+      - uses: gradle/actions/setup-gradle@v4
         with:
-          gradle-home-cache-cleanup: true
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
       - name: Document biojava-core
         run: ./gradlew :dokka-integration-tests:maven:testExternalProjectBioJava --stacktrace
         env:

.github/workflows/preview-publish-web-s3.yml

@@ -17,9 +17,9 @@ jobs:
         with:
           distribution: 'zulu'
           java-version: 17
-      - uses: gradle/actions/setup-gradle@v3
+      - uses: gradle/actions/setup-gradle@v4
         with:
-          gradle-home-cache-cleanup: true
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
       - name: Document coroutines
         run: ./gradlew :dokka-integration-tests:gradle:testExternalProjectKotlinxCoroutines --stacktrace "-Dorg.gradle.jvmargs=-Xmx2g -XX:MaxMetaspaceSize=500m"
         env:
@@ -31,7 +31,7 @@ jobs:
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           aws-region: eu-central-1
       - name: Copy files to dokka's S3 bucket
-        run: ./dokka-integration-tests/aws_sync.sh s3://${{ env.bucket-name }} coroutines ../coroutines
+        run: ./dokka-integration-tests/aws_sync.sh s3://${{ env.bucket-name }} coroutines ${{ github.workspace }}/dokka/coroutines
       - name: Print link
         run: echo https://dokka-snapshots.s3.eu-central-1.amazonaws.com/${{ env.branch-name }}/coroutines/${GITHUB_SHA::7}/index.html
 
@@ -45,9 +45,9 @@ jobs:
         with:
           distribution: 'zulu'
           java-version: 17
-      - uses: gradle/actions/setup-gradle@v3
+      - uses: gradle/actions/setup-gradle@v4
         with:
-          gradle-home-cache-cleanup: true
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
       - name: Document serialization
         run: ./gradlew :dokka-integration-tests:gradle:testExternalProjectKotlinxSerialization --stacktrace "-Dorg.gradle.jvmargs=-Xmx2g -XX:MaxMetaspaceSize=500m"
         env:
@@ -59,7 +59,7 @@ jobs:
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           aws-region: eu-central-1
       - name: Copy files to dokka's S3 bucket
-        run: ./dokka-integration-tests/aws_sync.sh s3://${{ env.bucket-name }} serialization ../serialization
+        run: ./dokka-integration-tests/aws_sync.sh s3://${{ env.bucket-name }} serialization ${{ github.workspace }}/dokka/serialization
       - name: Print link
         run: echo https://dokka-snapshots.s3.eu-central-1.amazonaws.com/${{ env.branch-name }}/serialization/${GITHUB_SHA::7}/index.html
 
@@ -73,9 +73,9 @@ jobs:
         with:
           distribution: 'zulu'
           java-version: 17
-      - uses: gradle/actions/setup-gradle@v3
+      - uses: gradle/actions/setup-gradle@v4
         with:
-          gradle-home-cache-cleanup: true
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
       - name: Generate ui-showcase documentation
         run: ./gradlew :dokka-integration-tests:gradle:testUiShowcaseProject
         env:
@@ -87,7 +87,7 @@ jobs:
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           aws-region: eu-central-1
       - name: Copy files to dokka's S3 bucket
-        run: ./dokka-integration-tests/aws_sync.sh s3://${{ env.bucket-name }} ui-showcase ../ui-showcase
+        run: ./dokka-integration-tests/aws_sync.sh s3://${{ env.bucket-name }} ui-showcase ${{ github.workspace }}/dokka/ui-showcase
       - name: Print link
         run: echo https://dokka-snapshots.s3.eu-central-1.amazonaws.com/${{ env.branch-name }}/ui-showcase/${GITHUB_SHA::7}/index.html
 
@@ -102,9 +102,9 @@ jobs:
           distribution: 'zulu'
           java-version: 17
           cache: 'maven'
-      - uses: gradle/actions/setup-gradle@v3
+      - uses: gradle/actions/setup-gradle@v4
         with:
-          gradle-home-cache-cleanup: true
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
       - name: Document biojava-core
         run: ./gradlew :dokka-integration-tests:maven:testExternalProjectBioJava --stacktrace
         env:
@@ -116,6 +116,6 @@ jobs:
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           aws-region: eu-central-1
       - name: Copy files to dokka's S3 bucket
-        run: ./dokka-integration-tests/aws_sync.sh s3://${{ env.bucket-name }} biojava ../biojava
+        run: ./dokka-integration-tests/aws_sync.sh s3://${{ env.bucket-name }} biojava ${{ github.workspace }}/dokka/biojava
       - name: Print link
         run: echo https://dokka-snapshots.s3.eu-central-1.amazonaws.com/${{ env.branch-name }}/biojava/${GITHUB_SHA::7}/index.html

.github/workflows/tests-smoke.yml

@@ -13,7 +13,7 @@ jobs:
   test-matrix:
     strategy:
       matrix:
-        os: [ ubuntu-latest, windows-latest ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
@@ -27,10 +27,21 @@ jobs:
         with:
           distribution: 'zulu'
           java-version: 17
-      - uses: gradle/actions/setup-gradle@v3
+      - uses: gradle/actions/setup-gradle@v4
         with:
-          gradle-home-cache-cleanup: true
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
       - name: Run tests
         run: >
-          ./gradlew test --stacktrace --continue 
+          ./gradlew check --stacktrace --continue
+          "-Porg.jetbrains.dokka.integration_test.skip=true"
           "-Porg.jetbrains.dokka.javaToolchain.testLauncher=${{ env.JAVA_TEST_VERSION }}"
+      - name: Upload build reports
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-reports-${{ runner.os }}-${{ github.action }}-${{ github.run_id }}
+          path: |
+            **/build/reports/
+            **/*.hprof
+            **/*.log
+          if-no-files-found: ignore

.github/workflows/tests-thorough.yml

@@ -25,10 +25,21 @@ jobs:
         with:
           distribution: 'zulu'
           java-version: 17
-      - uses: gradle/actions/setup-gradle@v3
+      - uses: gradle/actions/setup-gradle@v4
         with:
-          gradle-home-cache-cleanup: true
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
       - name: Run tests
         run: >
-          ./gradlew test --stacktrace --continue
+          ./gradlew check --stacktrace --continue
+          "-Porg.jetbrains.dokka.integration_test.skip=true"
           "-Porg.jetbrains.dokka.javaToolchain.testLauncher=${{ matrix.javaVersion }}"
+      - name: Upload build reports
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+           name: build-reports-${{ runner.os }}-${{ matrix.javaVersion }}-${{ github.action }}-${{ github.run_id }}
+           path: |
+              **/build/reports/
+              **/*.hprof
+              **/*.log
+           if-no-files-found: ignore

README.md

@@ -131,8 +131,8 @@ to learn how to use it.
 ### Android
 
 In addition to applying and configuring Dokka, you can apply Dokka's 
-[Android documentation plugin](plugins/android-documentation), which aims to improve documentation experience on the 
-Android platform:
+[Android documentation plugin](dokka-subprojects/plugin-android-documentation/README.md),
+which aims to improve documentation experience on the Android platform:
 
 <details open>
 <summary>Gradle Kotlin DSL</summary>

build-logic/build.gradle.kts

@@ -13,7 +13,6 @@ kotlin {
 }
 
 dependencies {
-    implementation(libs.gradlePlugin.dokka)
     implementation(libs.gradlePlugin.kotlin)
     implementation(libs.gradlePlugin.shadow)
     implementation("org.gradle.kotlin:gradle-kotlin-dsl-plugins:$expectedKotlinDslPluginsVersion")
@@ -24,4 +23,6 @@ dependencies {
     // workaround for accessing version-catalog in convention plugins
     // https://github.com/gradle/gradle/issues/15383#issuecomment-779893192
     implementation(files(libs.javaClass.superclass.protectionDomain.codeSource.location))
+
+    implementation(libs.gradlePlugin.gradle.develocity)
 }

build-logic/settings.gradle.kts

@@ -38,6 +38,5 @@ dependencyResolutionManagement {
 }
 
 plugins {
-    id("org.gradle.toolchains.foojay-resolver-convention") version "0.7.0"
-    id("dokkasettings.build-cache")
+    id("dokkasettings")
 }