Improvements to Action workflows (#21)

* Use release-drafter action to track changes
* Auto-deploy docs website on release
* Tweak caching in build workflow

Author: chrisbanes

.github/release-drafter.yml

@@ -0,0 +1,5 @@
+name-template: 'v$NEXT_PATCH_VERSION'
+tag-template: 'v$NEXT_PATCH_VERSION'
+template: |
+  ## What’s Changed
+  $CHANGES

.github/workflows/build.yml

@@ -32,9 +32,12 @@ jobs:
       - name: Generate cache key
         run: ./checksum.sh checksum.txt
 
-      - uses: actions/cache@v1
+      - uses: actions/cache@v2
         with:
-          path: ~/.gradle/caches
+          path: |
+            ~/.gradle/caches/modules-*
+            ~/.gradle/caches/jars-*
+            ~/.gradle/caches/build-cache-*
           key: gradle-${{ hashFiles('checksum.txt') }}
 
       - name: Build, lint and spotless
@@ -62,9 +65,12 @@ jobs:
       - name: Generate cache key
         run: ./checksum.sh checksum.txt
 
-      - uses: actions/cache@v1
+      - uses: actions/cache@v2
         with:
-          path: ~/.gradle/caches
+          path: |
+            ~/.gradle/caches/modules-*
+            ~/.gradle/caches/jars-*
+            ~/.gradle/caches/build-cache-*
           key: gradle-${{ hashFiles('checksum.txt') }}
 
       - name: Run tests
@@ -105,9 +111,12 @@ jobs:
       - name: Generate cache key
         run: ./checksum.sh checksum.txt
 
-      - uses: actions/cache@v1
+      - uses: actions/cache@v2
         with:
-          path: ~/.gradle/caches
+          path: |
+            ~/.gradle/caches/modules-*
+            ~/.gradle/caches/jars-*
+            ~/.gradle/caches/build-cache-*
           key: gradle-${{ hashFiles('checksum.txt') }}
 
       - name: Deploy to GitHub packages

.github/workflows/deploy_docs.yml

@@ -0,0 +1,45 @@
+name: Publish docs
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  deploy_docs:
+    runs-on: ubuntu-latest
+    env:
+      JAVA_TOOL_OPTIONS: -Xmx5120m
+      GRADLE_OPTS: -Dorg.gradle.daemon=false -Dorg.gradle.workers.max=2 -Dkotlin.compiler.execution.strategy=in-process
+      TERM: dumb
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup JDK 8 (1.8)
+        uses: actions/setup-java@v1
+        with:
+          java-version: 8
+
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          python3 -m pip install mkdocs
+          python3 -m pip install mkdocs-material
+
+      - name: Generate docs
+        run: ./generate_docs.sh
+
+      - name: Build site
+        run: mkdocs build
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site

.github/workflows/update-release.yml

@@ -0,0 +1,14 @@
+name: Update release
+
+on:
+  push:
+    branches:
+      - develop
+
+jobs:
+  update_draft_release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

deploy_docs.sh renamed to generate_docs.sh

@@ -6,5 +6,5 @@ cp CONTRIBUTING.md docs/contributing.md
 sed -i 's/CONTRIBUTING.md/\/contributing/' docs/index.md
 sed -i 's/docs\/using-snapshot-version.md/using-snapshot-version/' docs/index.md
 
-# Deploy to Github pages.
-mkdocs gh-deploy
+# Build the docs
+./gradlew clean dokka