1
0
Fork 0
mirror of https://github.com/rharkor/caching-for-turbo.git synced 2025-06-09 09:35:17 +09:00

docs: Why use this project

This commit is contained in:
rharkor 2025-02-20 18:24:50 +01:00
parent 9d1a2748a1
commit db7429ec08
8 changed files with 5293 additions and 5929 deletions

View file

@ -6,6 +6,48 @@ Supercharge your [Turborepo](https://turbo.build/repo/) builds with our
dedicated GitHub Actions caching service, designed to make your CI workflows
faster and more efficient.
## Why This Project?
This GitHub Action provides an alternative approach to Turborepo vercel remote
caching in CI/CD pipelines. While Vercel's official solution works well, there
are some key advantages to using this action:
### 1. Independent from Vercel
- No need for Vercel account or tokens
- Works entirely within GitHub's ecosystem
- Reduces external service dependencies
- Free forever
### 2. Granular Caching
The main technical difference lies in how caching is handled:
**Vercel's Approach**
- Uses a remote caching server hosted by Vercel
- Become expensive for large monorepos with multiple apps/packages
- May have limitations based on your Vercel plan
**This Action's Approach**
- Simulates a local remote caching server on `localhost:41230`
- Uses GitHub Actions' built-in caching system
- Github will automatically remove old cache entries
### 3. When to Use This?
This solution might be better when:
- You have a large monorepo with multiple apps/packages
- You want to avoid external service dependencies
- You need more control over your caching strategy
- You want to leverage GitHub's existing infrastructure
However, if you're already using Vercel and their remote caching works well for
your needs, there's no pressing need to switch. Both solutions are valid
approaches to the same problem.
## Quick Start
Easily integrate our caching action into your GitHub Actions workflow by adding