Fix external documentation links in Dokka config

robfletcher · Dec 10, 2019 · 921fa62 · 921fa62
1 parent e55b630
commit 921fa62
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 29 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -18,28 +18,10 @@ jobs:
         env:
           BINTRAY_USER: ${{ secrets.BINTRAY_USER }}
           BINTRAY_KEY: ${{ secrets.BINTRAY_KEY }}
-
-  site:
-    name: Publish site
-    needs: release
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v1
-      - name: Set up Java
-        uses: actions/setup-java@v1
-        with:
-          java-version: 1.8
       - name: Publish site
         run: ./gradlew :site:orchidDeploy -Prelease.useLastTag=true -Penv=prod
         env:
           GITHUB_TOKEN: ${{ secrets.GH_PAT }}
-
-  announce:
-    name: Announce release
-    needs: release
-    runs-on: ubuntu-latest
-    steps:
       - name: Tweet release announcement
         uses: xorilog/[email protected]
         with:

diff --git a/strikt-gradle/strikt-gradle.gradle.kts b/strikt-gradle/strikt-gradle.gradle.kts
@@ -20,9 +20,11 @@ dependencies {
 
 tasks.dokka {
   configuration {
-    externalDocumentationLink {
-      url =
-        URL("https://docs.gradle.org/${GradleVersion.current().version}/javadoc/")
+    "https://docs.gradle.org/${GradleVersion.current().version}/javadoc/".also {
+      externalDocumentationLink {
+        url = URL(it)
+        packageListUrl = URL(it + "package-list")
+      }
     }
   }
 }
diff --git a/strikt-jackson/strikt-jackson.gradle.kts b/strikt-jackson/strikt-jackson.gradle.kts
@@ -18,8 +18,11 @@ dependencies {
 
 tasks.dokka {
   configuration {
-    externalDocumentationLink {
-      url = URL("https://fasterxml.github.io/jackson-databind/javadoc/2.10/")
+    "https://fasterxml.github.io/jackson-databind/javadoc/2.10/".also {
+      externalDocumentationLink {
+        url = URL(it)
+        packageListUrl = URL(it + "package-list")
+      }
     }
   }
 }
diff --git a/strikt-protobuf/strikt-protobuf.gradle.kts b/strikt-protobuf/strikt-protobuf.gradle.kts
@@ -21,9 +21,11 @@ dependencies {
 
 tasks.dokka {
   configuration {
-    externalDocumentationLink {
-      url =
-        URL("https://developers.google.com/protocol-buffers/docs/reference/java/")
+    "https://developers.google.com/protocol-buffers/docs/reference/java/".also {
+      externalDocumentationLink {
+        url = URL(it)
+        packageListUrl = URL(it + "package-list")
+      }
     }
   }
 }

diff --git a/strikt-spring/strikt-spring.gradle.kts b/strikt-spring/strikt-spring.gradle.kts
@@ -24,9 +24,11 @@ dependencies {
 
 tasks.dokka {
   configuration {
-    externalDocumentationLink {
-      url =
-        URL("https://docs.spring.io/spring-framework/docs/current/javadoc-api/")
+    "https://docs.spring.io/spring-framework/docs/current/javadoc-api/".also {
+      externalDocumentationLink {
+        url = URL(it)
+        packageListUrl = URL(it + "package-list")
+      }
     }
   }
 }