Check README links are alive (#15)

Check README links are alive on PR open, merge and after pushing a new
javadoc version to `gh-pages`.

Author: gabrielfeo

.github/workflows/pr.yml

@@ -45,6 +45,10 @@ jobs:
         if: ${{ steps.diff.outputs.all_modified_files }}
         run: python3 -m unittest discover -bs .github/scripts
 
+  readme-links-test:
+    needs: [choose-dry-runs]
+    uses: ./.github/workflows/test-readme-links.yml
+
   choose-dry-runs:
     runs-on: ubuntu-latest
     outputs:

.github/workflows/publish-javadoc.yml

@@ -20,9 +20,6 @@ defaults:
   run:
     shell: bash
 
-env:
-  JAR_NAME: gradle-enterprise-api-kotlin-SNAPSHOT-javadoc.jar
-
 jobs:
 
   build-javadoc:
@@ -33,9 +30,9 @@ jobs:
       - name: Build javadoc
         uses: ./.github/actions/build
         with:
-          tasks: 'javadocJar'
-          artifact-name: 'javadoc'
-          path-to-upload: "build/libs/${{ env.JAR_NAME }}"
+          tasks: 'dokkaHtml'
+          artifact-name: 'docs'
+          path-to-upload: "build/dokka/html/**/*"
 
   publish-javadoc:
     needs: [build-javadoc]
@@ -45,13 +42,12 @@ jobs:
         uses: actions/checkout@v3
         with:
           ref: gh-pages
-      - name: Download javadoc
+      - name: Delete current javadoc
+        run: rm -rf docs
+      - name: Download new javadoc
         uses: actions/download-artifact@v3
-      - name: Unzip javadoc
-        run: |
-          rm -rf docs
-          unzip "javadoc/$JAR_NAME" -d docs
-          rm -rf javadoc
+        with:
+          path: ./
       - name: Commit
         run: |
           git config user.name github-actions

.github/workflows/test-readme-links.yml

@@ -0,0 +1,26 @@
+name: 'Check PR'
+
+on:
+  push:
+    branches:
+      - main
+      - gh-pages
+  workflow_call:
+  workflow_dispatch:
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+
+  test-readme-links:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Check README links
+        uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          folder-path: .
+          max-depth: 1