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