@rharkor/caching-for-turbo 2.4.2 → 2.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -26,8 +26,6 @@ The main technical difference lies in how caching is handled:
26
26
  **Vercel's Approach**
27
27
 
28
28
  - Uses a remote caching server hosted by Vercel
29
- - Become expensive for large monorepos with multiple apps/packages
30
- - May have limitations based on your Vercel plan
31
29
 
32
30
  **This Action's Approach**
33
31
 
@@ -213,6 +211,7 @@ with:
213
211
  cache-prefix: turbogha_ # Custom prefix for cache keys
214
212
  provider: github # Storage provider: 'github' (default) or 's3'
215
213
  server-port: 41230 # Port for the caching server (default: 41230, use 0 for auto-assign)
214
+ use-relative-cache-path: false # GitHub provider: use a runner-independent cache archive path
216
215
 
217
216
  # S3 Provider Configuration (variables will be read from environment variables if not provided)
218
217
  s3-access-key-id: ${{ secrets.S3_ACCESS_KEY_ID }} # S3 access key
@@ -234,6 +233,11 @@ By default, this action uses GitHub's built-in cache service, which offers:
234
233
  - No additional setup required
235
234
  - Automatic cache pruning by GitHub
236
235
 
236
+ Set `use-relative-cache-path: true` when jobs may save and restore the same
237
+ cache from runners with different temporary directories. The temporary cache
238
+ blob stays in `RUNNER_TEMP`, while the path passed to GitHub's cache service is
239
+ relative so cache versions can match across those runners.
240
+
237
241
  #### S3 Storage
238
242
 
239
243
  For teams requiring more control over caching infrastructure, the action