Skip to content

A Github action to set up Turborepo Remote Caching to work with GitHub Actions' built-in cache instead of Vercel one

License

Notifications You must be signed in to change notification settings

rharkor/caching-for-turbo

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

6c84b7e · Oct 30, 2024
Jun 13, 2024
Jul 2, 2024
Jun 25, 2024
Jun 12, 2024
Jun 25, 2024
Jun 13, 2024
Jun 12, 2024
Jun 13, 2024
Oct 29, 2024
Jun 12, 2024
Jun 12, 2024
Jun 12, 2024
Jun 27, 2024
Jun 23, 2024
Jun 25, 2024
Oct 29, 2024
Oct 29, 2024
Jun 13, 2024
Jun 12, 2024
Jun 13, 2024

Repository files navigation

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/[email protected]

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.