Add configurable compression support

Author: iby

README.md

@@ -5,7 +5,7 @@ Local file caching for self-hosted GitHub Actions runners. Made specifically for
 - [x] Relative, absolute, and tilde path support. 
 - [x] Multiple path caching support – cache several related paths in one step.
 - [x] Default cache location via `SELF_CACHED_DIR` environment variable.
-- [ ] Configurable cache compression for fine-tuning the performance.
+- [x] Configurable cache compression for fine-tuning the performance.
 - [ ] Glob support – not sure how it would work, but sounds useful…
 
 ## 💡 Usage

action.yml

@@ -10,6 +10,9 @@ inputs:
   dir:
     description: A directory path for storing (to) and restoring (from) the cache. Defaults to $SELF_CACHED_DIR or $RUNNER_TOOL_CACHE if not set.
     required: false
+  compress:
+    description: Specifies whether to compress cache using tar. Defaults to $SELF_CACHED_COMPRESS or true if not set.
+    required: false
 outputs:
   cache-hit:
     description: Specifies whether the cache was restored or not.

product/dist/Restore.js

@@ -1,11 +1,12 @@
 import * as core from '@actions/core';
-import { getDirInput, Input, Output, restore, State } from './Util';
+import { getCompressInput, getDirInput, Input, Output, restore, State } from './Util';
 
 (async (): Promise<void> => {
   try {
     const paths = core.getInput(Input.Path, { required: true }).split(/\r?\n/).map(p => p.trim()).filter(p => p.length > 0);
     const key = core.getInput(Input.Key, { required: true });
     const dir = getDirInput(core.getInput(Input.Dir, { required: false }));
+    const compress = getCompressInput(core.getInput(Input.Compress, { required: false }));
 
     if (!paths.length || !key || !dir) {
       core.info('Missing inputs, skipping cache restore.');
@@ -16,8 +17,9 @@ import { getDirInput, Input, Output, restore, State } from './Util';
     core.saveState(State.CacheKey, key);
     core.saveState(State.CacheDir, dir);
     core.saveState(State.CachePaths, JSON.stringify(paths));
+    core.saveState(State.CacheCompress, compress.toString());
 
-    const isRestored = await restore(paths, key, dir);
+    const isRestored = await restore(paths, key, dir, compress);
     core.setOutput(Output.CacheHit, isRestored.toString());
 
     if (isRestored) {

product/dist/Store.js

@@ -6,13 +6,14 @@ import { State, store } from './Util';
     const paths = JSON.parse(core.getState(State.CachePaths) || '[]');
     const key = core.getState(State.CacheKey);
     const dir = core.getState(State.CacheDir);
+    const compress = core.getState(State.CacheCompress) === 'true';
 
     if (!paths.length || !key || !dir) {
       core.info('Missing state inputs, skipping cache store.');
       return;
     }
 
-    await store(paths, key, dir);
+    await store(paths, key, dir, compress);
   } catch (error) {
     core.setFailed(error instanceof Error ? error.message : `Unknown error occurred during restore: ${error}`);
   }