1
0
Fork 0
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
Find a file
renovate[bot] 3c5a0c943c
chore(deps): update node.js to v22.14.0 (#238)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-02-11 16:07:25 +00:00
.devcontainer chore(deps): update mcr.microsoft.com/devcontainers/typescript-node docker tag to v22 2024-06-13 14:24:06 +00:00
.github Delete .github/dependabot.yml 2024-07-02 15:36:46 +02:00
dist fix: use runner.temp for tmp cache file 2024-06-25 21:23:22 +02:00
script first commit 2024-06-12 19:56:12 +02:00
src fix: cache 2024-06-25 18:11:47 +02:00
.eslintignore fix: action 2024-06-13 14:37:32 +02:00
.gitattributes first commit 2024-06-12 19:56:12 +02:00
.gitignore fix: ci 2024-06-13 13:53:22 +00:00
.node-version chore(deps): update node.js to v22.14.0 (#238) 2025-02-11 16:07:25 +00:00
.prettierignore first commit 2024-06-12 19:56:12 +02:00
.prettierrc.json first commit 2024-06-12 19:56:12 +02:00
action.yml fix: action 2024-06-23 15:08:36 +02:00
check-full-turbo.sh fix (windows): ci 2024-06-25 21:25:44 +02:00
LICENSE first commit 2024-06-12 19:56:12 +02:00
package-lock.json chore(deps): update dependency turbo to v2.4.1 (#237) 2025-02-11 10:50:30 +00:00
package.json chore(deps): update npm to v11.1.0 (#230) 2025-01-30 14:32:50 +00:00
README.md fix: readme link 2024-06-27 10:44:23 +02:00
renovate.json fix: renovate 2024-06-13 16:20:50 +02:00
tsconfig.json first commit 2024-06-12 19:56:12 +02:00
turbo.json feat: store cache 2024-06-13 14:27:20 +02:00

Caching for Turborepo with GitHub Actions

CI Status

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:

  1. Server Initialization: Automatically spins up a server on localhost:41230.
  2. Environment Setup: Sets up TURBO_API, TURBO_TOKEN, and TURBO_TEAM environment variables required by turbo build.
  3. 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

  1. Start the development server:

    npm run dev-run
    
  2. 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.