From 3f6a188f541af26478cdcffd101336ddd610e5d8 Mon Sep 17 00:00:00 2001
From: Rick Busarow <rickbusarow@gmail.com>
Date: Mon, 26 Jun 2023 09:47:03 -0500
Subject: [PATCH] GH Actions caching tweaks

### Removed

- don't bother caching/restoring `~/.gradle/wrapper` with `actions/cache/___` steps.
  - It's already cached by `gradle/gradle-build-action`
- don't use cross-OS archiving.
  - Gradle doesn't seem to like it, even just going between Ubuntu and MacOS.
- remove the `lookup-only` toggle for the initial cache-restore step (default is false).
  - The property was left there in error.  If we get a cache hit on the `cache-write-key`, we definitely want to download it.

### Added

- make an explicit default of 'null' for cache keys, and check if the value is 'null' in a step's `if` condition instead of just checking whether a value is there.
  - The `gradle-task-with-commit` action forwards its keys to this action.  Prior to this, if no key was specified when invoking that action, the `gradle-task-with-commit` action passes a key of '' to the `gradle-task` action.  The result would be saving and restoring a blank key with who-knows-what in the cache.
- cache every project build directory (`./**/build/**`) since they tend to be quite small
- add the `${{runner.os}}-` prefix to `key` and `restore-keys` arguments.
  - Otherwise, caches for MacOS and Ubuntu would have the same keys -- which is bad when cross-OS archiving is disabled.
---
 .github/actions/gradle-task/action.yml | 69 +++++++++++++-------------
 1 file changed, 34 insertions(+), 35 deletions(-)

diff --git a/.github/actions/gradle-task/action.yml b/.github/actions/gradle-task/action.yml
index 6462375bfc..50b9874beb 100644
--- a/.github/actions/gradle-task/action.yml
+++ b/.github/actions/gradle-task/action.yml
@@ -16,8 +16,10 @@ inputs :
     default : 'zulu'
   restore-cache-key :
     description : 'The unique identifier for the associated cache.  Any other consumers or producers for this cache must use the same name.'
+    default : 'null'
   write-cache-key :
     description : 'The unique identifier for the associated cache.  Any other consumers or producers for this cache must use the same name.'
+    default : 'null'
 
 runs :
   using : 'composite'
@@ -26,8 +28,8 @@ runs :
     - name : Set up JDK
       uses : actions/setup-java@v3
       with :
-        distribution : ${{ inputs.distribution }}
-        java-version : ${{ inputs.java-version }}
+        distribution : ${{inputs.distribution}}
+        java-version : ${{inputs.java-version}}
 
     - name : Set Gradle Args for runner OS
       id : gradle-args
@@ -42,63 +44,60 @@ runs :
     # Attempt to restore from the write-cache-key, or fall back to a partial match for the write key.
     # Skipped if the write-cache-key wasn't set.
     # This step's "cache_hit" output will only be true if an exact match was found.
-    - name: restore cache for ${{inputs.write-cache-key}}
-      id: restore-write-cache
-      if: ${{inputs.write-cache-key}} != ''
-      uses: actions/cache/restore@v3
-      with:
-        path: |
+    - name : restore cache for ${{inputs.write-cache-key}}
+      id : restore-write-cache
+      if : inputs.write-cache-key != 'null'
+      uses : actions/cache/restore@v3
+      with :
+        path : |
           ~/.gradle/caches/build-cache-1
-          ~/.gradle/wrapper
-        key: ${{inputs.write-cache-key}}-${{ hashFiles('**/*.gradle.kt*') }}-${{ hashFiles('**/libs.versions.toml') }}-${{ hashFiles('**/gradle.properties') }}
-        restore-keys: ${{inputs.write-cache-key}}
-        enableCrossOsArchive: true
-        lookup-only: true
+          ./**/build/**
+        key : ${{runner.os}}-${{inputs.write-cache-key}}-${{hashFiles('**/*.gradle.kt*')}}-${{hashFiles('**/libs.versions.toml')}}-${{hashFiles('**/gradle.properties')}}
+        restore-keys : ${{runner.os}}-${{inputs.write-cache-key}}
 
     # Attempt to restore from the restore-cache-key, or fall back to a partial match for the restore key.
     # Skipped if the restore-cache-key wasn't set, or if the write-cache-key restore had an exact match.
-    - name: restore cache for ${{inputs.restore-cache-key}}
-      if: ${{inputs.restore-cache-key}} != '' && steps.restore-write-cache.outputs.cache-hit != 'true'
-      uses: actions/cache/restore@v3
-      with:
-        path: |
+    - name : restore cache for ${{inputs.restore-cache-key}}
+      if : inputs.restore-cache-key != 'null' && steps.restore-write-cache.outputs.cache-hit != 'true'
+      uses : actions/cache/restore@v3
+      with :
+        path : |
           ~/.gradle/caches/build-cache-1
-          ~/.gradle/wrapper
-        key: ${{inputs.restore-cache-key}}-${{ hashFiles('**/*.gradle.kt*') }}-${{ hashFiles('**/libs.versions.toml') }}-${{ hashFiles('**/gradle.properties') }}
-        restore-keys: ${{inputs.restore-cache-key}}
-        enableCrossOsArchive: true
+          ./**/build/**
+        key : ${{runner.os}}-${{inputs.restore-cache-key}}-${{hashFiles('**/*.gradle.kt*')}}-${{hashFiles('**/libs.versions.toml')}}-${{hashFiles('**/gradle.properties')}}
+        restore-keys : ${{runner.os}}-${{inputs.restore-cache-key}}
 
-    - uses: gradle/wrapper-validation-action@v1
+    - uses : gradle/wrapper-validation-action@v1
 
     # Run the actual task.  Note that this still uses gradle-build-action for more fine-grained caching.
-    - name : Run ${{ inputs.task }}
+    - name : Run ${{inputs.task}}
       uses : gradle/gradle-build-action@v2
       with :
         # These arguments need to be on a single line. If they're defined with wrapping (using `|`),
         # something along the way to the actual CLI invocation gets confused and the jvmargs list
         # winds up getting parsed as a single argument.
-        arguments : ${{ steps.gradle-args.outputs.gradle-property-args }} ${{ inputs.task }} '-Dorg.gradle.jvmargs=${{ steps.gradle-args.outputs.gradle-jvm-args }}'
+        arguments : ${{steps.gradle-args.outputs.gradle-property-args}} ${{inputs.task}} '-Dorg.gradle.jvmargs=${{steps.gradle-args.outputs.gradle-jvm-args}}'
         cache-read-only : false
-        build-root-directory : ${{ inputs.build-root-directory }}
+        build-root-directory : ${{inputs.build-root-directory}}
         gradle-home-cache-cleanup : true
 
     # Save the build cache to `write-cache-key`.
     # Skip if we already had an exact match, or if the key is not set, or if this is a Windows runner.
     # Windows runners are welcome to *read* the cross-OS cache, but the directories get weird if
     # they try to write to it.
-    - name: save the '${{inputs.write-cache-key}}' cache
-      uses: actions/cache/save@v3
-      id: save-write-cache-key
-      if: ${{inputs.write-cache-key}} != '' && steps.restore-write-cache.outputs.cache-hit != 'true' && runner.os != 'Windows'
-      with:
-        path: |
+    - name : save the '${{inputs.write-cache-key}}' cache
+      uses : actions/cache/save@v3
+      id : save-write-cache-key
+      if : inputs.write-cache-key != 'null' && steps.restore-write-cache.outputs.cache-hit != 'true'
+      with :
+        path : |
           ~/.gradle/caches/build-cache-1
-          ~/.gradle/wrapper
-        key: ${{inputs.write-cache-key}}-${{ hashFiles('**/*.gradle.kt*') }}-${{ hashFiles('**/libs.versions.toml') }}-${{ hashFiles('**/gradle.properties') }}
+          ./**/build/**
+        key : ${{runner.os}}-${{inputs.write-cache-key}}-${{hashFiles('**/*.gradle.kt*')}}-${{hashFiles('**/libs.versions.toml')}}-${{hashFiles('**/gradle.properties')}}
 
     - name : Upload heap dump
       if : failure()
       uses : actions/upload-artifact@v3
       with :
         name : heap-dump
-        path : ${{ github.workspace }}/**/*{.hprof,.log}
+        path : ${{github.workspace}}/**/*{.hprof,.log}