Update to Gradle 7.2 and Dokka 1.5.31 (#885)

Co-authored-by: Simon Vergauwen <[email protected]> Co-authored-by: Raúl Raja Martínez <[email protected]>
arrow-kt · Oct 26, 2021 · 126fe0b · 126fe0b
1 parent fadce1d
commit 126fe0b
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 8 deletions.
diff --git a/build.gradle b/build.gradle
@@ -14,11 +14,30 @@ plugins {
 configure(subprojects - project("docs")
 ) {
     apply plugin: "org.jetbrains.dokka"
-    dokka {
-        outputFormat = 'jekyll'
-        outputDirectory = PATH_APIDOCS
-        configuration {
-            includes = ['README.md']
+    dokkaGfm {
+        outputDirectory = file(PATH_APIDOCS)
+        dokkaSourceSets {
+            if (file("src/main/kotlin").exists()) {
+                main {
+                    skipDeprecated.set(true)
+                    reportUndocumented.set(true)
+                    sourceLink {
+                        localDirectory.set(file("src/main/kotlin"))
+                        remoteUrl.set(uri("https://github.com/arrow-kt/arrow-meta/blob/main/${relativeProjectPath('src/main/kotlin')}").toURL())
+                        remoteLineSuffix.set("#L")
+                    }
+                }
+            } else if (file("src/commonMain/kotlin").exists()) {
+                main {
+                    skipDeprecated.set(true)
+                    reportUndocumented.set(true)
+                    sourceLink {
+                        localDirectory.set(file("src/commonMain/kotlin"))
+                        remoteUrl.set(uri("https://github.com/arrow-kt/arrow-meta/blob/main/${relativeProjectPath('src/commonMain/kotlin')}").toURL())
+                        remoteLineSuffix.set("#L")
+                    }
+                }
+            }
         }
     }
 }
@@ -85,7 +104,7 @@ allprojects {
 
 task generateDoc(type: Exec) {
     // Reason of commandLine: to avoid specifying the list of modules
-    commandLine "sh", "gradlew", "dokka"
+    commandLine "sh", "gradlew", "dokkaGfm"
 }
 
 task runValidation(type: Exec) {

diff --git a/gradle.properties b/gradle.properties
@@ -11,7 +11,7 @@ KTLINT_VERSION=0.42.1
 KTLINT_GRADLE_VERSION=10.1.0
 KOTEST_VERSION=5.0.0.M2
 ASSERTJ_VERSION=3.13.2
-DOKKA_VERSION=0.10.0
+DOKKA_VERSION=1.5.31
 CLASS_GRAPH_VERSION=4.8.47
 JUNIT_VERSION=5.8.0
 KOTLIN_COMPILE_TESTING=1.4.4

diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.9.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists