add cache-scratchspaces and default enabled (#63)

Bumps [actions/checkout](https://github.com/actions/checkout) from 4.0.0 to 4.1.0.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](3df4ab11eb...8ade135a41)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.github/workflows/CI.yml

@@ -23,7 +23,7 @@ jobs:
       run: 'write("random.txt", string(rand(10)))'
     - name: Set cache-name as output
       id: name
-      run: echo "::set-output name=cache-name::${{ hashFiles('random.txt') }}"
+      run: echo "cache-name=${{ hashFiles('random.txt') }}" >> $GITHUB_OUTPUT
 
   test-save:
     needs: generate-key
@@ -33,7 +33,7 @@ jobs:
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579
+    - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
     - name: Save cache
       id: cache
       uses: ./
@@ -56,7 +56,7 @@ jobs:
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579
+    - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
     - name: Restore cache
       id: cache
       uses: ./
@@ -69,11 +69,16 @@ jobs:
         @assert ENV["cache-hit"] == "true"
       env:
         cache-hit: ${{ steps.cache.outputs.cache-hit }}
-    - name: Check non-empty artifacts and packages dir
+    - name: Check existance or emptiness of affected dirs
       shell: 'julia --color=yes {0}'
       run: |
+        # Artifacts and Packages should exist as they've been cached
         artifacts_dir = joinpath(first(DEPOT_PATH), "artifacts")
         @assert !isempty(readdir(artifacts_dir))
         packages_dir = joinpath(first(DEPOT_PATH), "packages")
         @assert !isempty(readdir(packages_dir))
 
+        # Caching the compiled dir is disabled by default and should not exist after restoring a cache
+        compiled_dir = joinpath(first(DEPOT_PATH), "compiled")
+        @assert !isdir(compiled_dir) || isempty(readdir(compiled_dir))
+

README.md

@@ -15,7 +15,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - uses: julia-actions/setup-julia@v1
     - uses: julia-actions/cache@v1
     - uses: julia-actions/julia-buildpkg@v1
@@ -40,6 +40,8 @@ That is why caching the registries is disabled by default.
 - `cache-artifacts` - Whether to cache `~/.julia/artifacts/`. Enabled by default.
 - `cache-packages` - Whether to cache `~/.julia/packages/`. Enabled by default.
 - `cache-registries` - Whether to cache `~/.julia/registries/`. Disabled by default.
+- `cache-compiled` - Whether to cache `~/.julia/compiled/`. Disabled by default. **USE ONLY IF YOU KNOW WHAT YOU'RE DOING!** See [#11](https://github.com/julia-actions/cache/issues/11).
+- `cache-scratchspaces` - Whether to cache `~/.julia/scratchspaces/`. Enabled by default.
 
 ### Outputs
 
@@ -50,7 +52,7 @@ That is why caching the registries is disabled by default.
 This action is a wrapper around <https://github.com/actions/cache>.
 In summary, this action stores the files in the aforementioned paths in one compressed file when running for the first time.
 This cached file is then restored upon the second run.
-The benefit of this is that downloading one big file is more quick than downloading many different files from many different locations.
+The benefit of this is that downloading one big file is quicker than downloading many different files from many different locations.
 
 ## Third Party Notice
 

action.yml

@@ -19,6 +19,12 @@ inputs:
   cache-registries:
     description: 'Whether to cache ~/.julia/registries/'
     default: 'false'
+  cache-compiled:
+    description: 'Whether to cache ~/.julia/compiled. USE WITH CAUTION! See https://github.com/julia-actions/cache/issues/11 for caveats.'
+    default: 'false'
+  cache-scratchspaces:
+    description: 'Whether to cache ~/.julia/scratchspaces/'
+    default: 'true'
 
 outputs:
   cache-hit:
@@ -31,23 +37,27 @@ runs:
     - id: paths
       run: |
         [ "${{ inputs.cache-artifacts }}" = "true" ] && A_PATH="~/.julia/artifacts"
-        echo "ARTIFACTS_PATH=$A_PATH" >> $GITHUB_ENV
+        echo "artifacts-path=$A_PATH" >> $GITHUB_OUTPUT
         [ "${{ inputs.cache-packages }}" = "true" ] && P_PATH="~/.julia/packages"
-        echo "PACKAGES_PATH=$P_PATH" >> $GITHUB_ENV
+        echo "packages-path=$P_PATH" >> $GITHUB_OUTPUT
         [ "${{ inputs.cache-registries }}" = "true" ] && R_PATH="~/.julia/registries"
-        echo "REGISTRIES_PATH=$R_PATH" >> $GITHUB_ENV
+        echo "registries-path=$R_PATH" >> $GITHUB_OUTPUT
+        [ "${{ inputs.cache-compiled }}" = "true" ] && PCC_PATH="~/.julia/compiled"
+        echo "precompilation-cache-path=$PCC_PATH" >> $GITHUB_OUTPUT
+        [ "${{ inputs.cache-scratchspaces }}" = "true" ] && S_PATH="~/.julia/scratchspaces"
+        echo "scratchspaces-path=$S_PATH" >> $GITHUB_OUTPUT
       shell: bash
 
-    - uses: actions/cache@937d24475381cd9c75ae6db12cb4e79714b926ed
+    - uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84
       id: cache
       with:
-        path: "${{ format('{0}\n{1}\n{2}', env.ARTIFACTS_PATH, env.PACKAGES_PATH, env.REGISTRIES_PATH) }}"
-        key: ${{ runner.os }}-test-${{ inputs.cache-name }}-${{ hashFiles('**/Project.toml') }}
+        path: "${{ format('{0}\n{1}\n{2}\n{3}\n{4}', steps.paths.outputs.artifacts-path, steps.paths.outputs.packages-path, steps.paths.outputs.registries-path, steps.paths.outputs.precompilation-cache-path, steps.paths.outputs.scratchspaces-path) }}"
+        key: ${{ runner.os }}-${{ inputs.cache-name }}-${{ hashFiles('**/Project.toml') }}
         restore-keys: |
-          ${{ runner.os }}-test-${{ inputs.cache-name }}-
+          ${{ runner.os }}-${{ inputs.cache-name }}-
 
     - id: hit
-      run: echo "::set-output name=cache-hit::$(echo $CACHE_HIT)"
+      run: echo "cache-hit=$CACHE_HIT" >> $GITHUB_OUTPUT
       env:
         CACHE_HIT: ${{ steps.cache.outputs.cache-hit }}
       shell: bash