@rharkor/caching-for-turbo 2.2.2 → 2.2.3

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.
Files changed (3) hide show
  1. package/README.md +36 -0
  2. package/dist/cli/index.js +593 -129
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -48,6 +48,42 @@ However, if you're already using Vercel and their remote caching works well for
48
48
  your needs, there's no pressing need to switch. Both solutions are valid
49
49
  approaches to the same problem.
50
50
 
51
+ ## Comparison with Other Approaches
52
+
53
+ ### GitHub Actions Built-in Cache
54
+
55
+ Turborepo's [official documentation](https://turborepo.com/docs/guides/ci-vendors/github-actions#remote-caching-with-github-actionscache) also mentions using GitHub Actions' built-in cache directly. Here's how our approach compares:
56
+
57
+ **GitHub Actions Built-in Cache Approach**
58
+
59
+ - Uses `actions/cache` action directly with Turborepo's cache outputs
60
+ - Simpler setup with fewer moving parts
61
+ - Limited to GitHub's cache storage only
62
+
63
+ **This Action's Approach**
64
+
65
+ - Provides a modular caching solution with multiple storage backends
66
+ - Supports both GitHub Actions cache and S3 storage
67
+ - Offers more control over cache retention and cleanup policies
68
+ - Enables local development with the same caching infrastructure
69
+
70
+ ### When to Choose Each Approach
71
+
72
+ **Choose GitHub Actions Built-in Cache when:**
73
+ - You want the simplest possible setup
74
+ - You're only using GitHub Actions for CI
75
+ - You don't need advanced cache management features
76
+ - You're satisfied with GitHub's cache storage limitations
77
+
78
+ **Choose This Action when:**
79
+ - You need more granular cache control
80
+ - You want to use S3 or other storage backends
81
+ - You need advanced cleanup and retention policies
82
+ - You want to use the same caching infrastructure locally and in CI
83
+ - You have a large monorepo where modular caching provides benefits
84
+
85
+ Both approaches are valid and serve different use cases. The built-in cache approach is simpler and has been available for a long time, while this action provides more flexibility and features.
86
+
51
87
  ## Quick Start
52
88
 
53
89
  Easily integrate our caching action into your GitHub Actions workflow by adding