mirror of
https://github.com/rharkor/caching-for-turbo.git
synced 2025-06-09 17:44:48 +09:00
docs: Why use this project
This commit is contained in:
parent
9d1a2748a1
commit
db7429ec08
8 changed files with 5293 additions and 5929 deletions
42
README.md
42
README.md
|
@ -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
|
dedicated GitHub Actions caching service, designed to make your CI workflows
|
||||||
faster and more efficient.
|
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
|
## Quick Start
|
||||||
|
|
||||||
Easily integrate our caching action into your GitHub Actions workflow by adding
|
Easily integrate our caching action into your GitHub Actions workflow by adding
|
||||||
|
|
1252
dist/post/index.js
generated
vendored
1252
dist/post/index.js
generated
vendored
File diff suppressed because one or more lines are too long
2
dist/post/index.js.map
generated
vendored
2
dist/post/index.js.map
generated
vendored
File diff suppressed because one or more lines are too long
2
dist/post/sourcemap-register.js
generated
vendored
2
dist/post/sourcemap-register.js
generated
vendored
File diff suppressed because one or more lines are too long
9882
dist/setup/index.js
generated
vendored
9882
dist/setup/index.js
generated
vendored
File diff suppressed because one or more lines are too long
2
dist/setup/index.js.map
generated
vendored
2
dist/setup/index.js.map
generated
vendored
File diff suppressed because one or more lines are too long
38
dist/setup/licenses.txt
generated
vendored
38
dist/setup/licenses.txt
generated
vendored
|
@ -1534,25 +1534,6 @@ licenses; we recommend you read them, as their terms may differ from the
|
||||||
terms above.
|
terms above.
|
||||||
|
|
||||||
|
|
||||||
lru-cache
|
|
||||||
ISC
|
|
||||||
The ISC License
|
|
||||||
|
|
||||||
Copyright (c) Isaac Z. Schlueter and Contributors
|
|
||||||
|
|
||||||
Permission to use, copy, modify, and/or distribute this software for any
|
|
||||||
purpose with or without fee is hereby granted, provided that the above
|
|
||||||
copyright notice and this permission notice appear in all copies.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
||||||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
||||||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
||||||
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
||||||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
||||||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
|
|
||||||
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
||||||
|
|
||||||
|
|
||||||
mime-db
|
mime-db
|
||||||
MIT
|
MIT
|
||||||
(The MIT License)
|
(The MIT License)
|
||||||
|
@ -2505,22 +2486,3 @@ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
|
||||||
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||||
|
|
||||||
|
|
||||||
yallist
|
|
||||||
ISC
|
|
||||||
The ISC License
|
|
||||||
|
|
||||||
Copyright (c) Isaac Z. Schlueter and Contributors
|
|
||||||
|
|
||||||
Permission to use, copy, modify, and/or distribute this software for any
|
|
||||||
purpose with or without fee is hereby granted, provided that the above
|
|
||||||
copyright notice and this permission notice appear in all copies.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
||||||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
||||||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
||||||
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
||||||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
||||||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
|
|
||||||
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
||||||
|
|
2
dist/setup/sourcemap-register.js
generated
vendored
2
dist/setup/sourcemap-register.js
generated
vendored
File diff suppressed because one or more lines are too long
Loading…
Add table
Add a link
Reference in a new issue