Merge pull request #86 from sbt/wip/cache

Add disk cache

Author: eed3si9n

.github/workflows/ci.yml

@@ -12,15 +12,12 @@ jobs:
           - os: ubuntu-22.04
             java: 17
             distribution: temurin
-          - os: ubuntu-24.04
-            java: 8
-            distribution: zulu
           - os: macos-14
-            java: 8
+            java: 17
             distribution: zulu
           - os: windows-2022
-            java: 8
-            distribution: zulu
+            java: 17
+            distribution: temurin
     runs-on: ${{ matrix.os }}
     env:
       JAVA_OPTS: -Xms2048M -Xmx2048M -Xss6M -XX:ReservedCodeCacheSize=256M -Dfile.encoding=UTF-8
@@ -33,6 +30,13 @@ jobs:
           java-version: ${{ matrix.java }}
           cache: sbt
       - uses: ./
-      - name: Build and test
+      - name: Build and test root
         shell: bash
         run: sbt -v +test
+      - name: Build and test sbt 2
+        shell: bash
+        run: |
+          pushd example
+          sbt -v test
+          sbt -v test
+          popd

README.md

@@ -29,8 +29,10 @@ steps:
 
 ### Setting the runner version
 
-The `sbt` runner (Bash script that launches sbt) is typically compatible with all modern sbt releases,
-you might want to pin the runner to a specific version.
+The `sbt` runner is typically compatible with all modern sbt releases.
+However, the launcher distributed by sbt 2.x will require JDK 17.
+
+You can pin the `sbt` runner back to sbt 1.x to run JDK 8:
 
 ```yaml
 env:
@@ -40,12 +42,25 @@ steps:
 - name: Setup JDK
   uses: actions/setup-java@v5
   with:
-    distribution: temurin
-    java-version: 17
+    distribution: zulu
+    java-version: 8
     cache: sbt
 - uses: sbt/setup-sbt@v1
   with:
-    sbt-runner-version: 1.9.9
+    sbt-runner-version: 1.12.11
+- name: Build and test
+  shell: bash
+  run: sbt -v +test
+```
+
+### Opting out of disk cache
+
+By default setup-sbt enables the disk cache on sbt 2.x. This can be opted out as follows:
+
+```yaml
+- uses: sbt/setup-sbt@v1
+  with:
+    disk-cache: false
 - name: Build and test
   shell: bash
   run: sbt -v +test

action.yml

@@ -5,6 +5,10 @@ inputs:
     description: "The runner version (The actual version is controlled via project/build.properties)"
     required: true
     default: 1.12.11
+  disk-cache:
+    description: "Enable sbt 2.x disk cache"
+    required: false
+    default: true
 runs:
   using: "composite"
   steps:
@@ -18,11 +22,18 @@ runs:
         if [[ "$RUNNER_OS" == "Windows" ]]; then
           echo "sbt_toolpath=$RUNNER_TOOL_CACHE\\sbt\\$SBT_RUNNER_VERSION" >> "$GITHUB_OUTPUT"
           echo "sbt_downloadpath=$RUNNER_TEMP\\_sbt" >> "$GITHUB_OUTPUT"
+          echo "sbt_diskcache=$HOME\\AppData\\Local\\sbt" >> "$GITHUB_OUTPUT"
+        elif [[ "$RUNNER_OS" == "macOS" ]]; then
+          echo "sbt_toolpath=$RUNNER_TOOL_CACHE/sbt/$SBT_RUNNER_VERSION" >> "$GITHUB_OUTPUT"
+          echo "sbt_downloadpath=$RUNNER_TEMP/_sbt" >> "$GITHUB_OUTPUT"
+          echo "sbt_diskcache=$HOME/Library/Caches/sbt" >> "$GITHUB_OUTPUT"
         else
           echo "sbt_toolpath=$RUNNER_TOOL_CACHE/sbt/$SBT_RUNNER_VERSION" >> "$GITHUB_OUTPUT"
           echo "sbt_downloadpath=$RUNNER_TEMP/_sbt" >> "$GITHUB_OUTPUT"
+          echo "sbt_diskcache=$HOME/.cache/sbt" >> "$GITHUB_OUTPUT"
         fi
         echo "sbt_cachekey=$RUNNER_OS-sbt-$SBT_RUNNER_VERSION-$SBT_CACHE_KEY_VERSION" >> "$GITHUB_OUTPUT"
+        echo "sbt_diskcachekey=$RUNNER_OS-sbt-diskcache-$SBT_CACHE_KEY_VERSION" >> "$GITHUB_OUTPUT"
     - name: Check Tool Cache
       id: cache-tool-dir
       shell: bash
@@ -42,6 +53,13 @@ runs:
       with:
         path: ${{ steps.cache-paths.outputs.sbt_toolpath }}
         key: ${{ steps.cache-paths.outputs.sbt_cachekey }}
+    - name: sbt 2.x disk cache
+      id: disk-cache
+      if: inputs.disk-cache == 'true'
+      uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
+      with:
+        path: ${{ steps.cache-paths.outputs.sbt_diskcache }}
+        key: ${{ steps.cache-paths.outputs.sbt_diskcachekey }}
     - name: "Download and Install sbt"
       shell: bash
       env:

example/build.sbt

@@ -0,0 +1,3 @@
+scalaVersion := "3.8.3"
+val munit = "org.scalameta" %% "munit" % "1.0.4"
+libraryDependencies += munit % Test

example/project/build.properties

@@ -0,0 +1 @@
+sbt.version=2.0.0-RC13

example/src/test/scala/example/ATest.scala

@@ -0,0 +1,8 @@
+package example
+
+import munit.*
+
+class ATest extends FunSuite:
+  test("sum"):
+    assert(1 + 1 == 2)
+end ATest