mirror of
https://github.com/rharkor/caching-for-turbo.git
synced 2025-06-08 01:37:01 +09:00
A Github action to set up Turborepo Remote Caching to work with GitHub Actions' built-in cache instead of Vercel one
|
||
---|---|---|
.devcontainer | ||
.github | ||
dist | ||
script | ||
src | ||
.eslintignore | ||
.gitattributes | ||
.gitignore | ||
.node-version | ||
.prettierignore | ||
.prettierrc.json | ||
action.yml | ||
check-full-turbo.sh | ||
LICENSE | ||
package-lock.json | ||
package.json | ||
README.md | ||
renovate.json | ||
tsconfig.json | ||
turbo.json |
Caching for Turborepo with GitHub Actions
Supercharge your Turborepo builds with our dedicated GitHub Actions caching service, designed to make your CI workflows faster and more efficient.
Quick Start
Easily integrate our caching action into your GitHub Actions workflow by adding
the following step before you run turbo build
:
- name: Cache for Turbo
uses: rharkor/caching-for-turbo@v1.5
This GitHub Action facilitates:
- Server Initialization: Automatically spins up a server on
localhost:41230
. - Environment Setup: Sets up
TURBO_API
,TURBO_TOKEN
, andTURBO_TEAM
environment variables required byturbo build
. - Efficient Caching: Leverages GitHub's cache service to significantly accelerate build times.
Configurable Options
Customize the caching behavior with the following optional settings (defaults provided):
with:
cache-prefix: turbogha_ # Custom prefix for cache keys
Contributing
Set Up Your Development Environment
-
Start the development server:
npm run dev-run
-
In a separate terminal, execute the tests:
npm test
Licensing
Licensed under the MIT License. For more details, see the LICENSE file.
Acknowledgements
This project is inspired by dtinth and has been comprehensively rewritten for enhanced robustness and reliability.