Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 1.6 KB

README.md

File metadata and controls

63 lines (43 loc) · 1.6 KB

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.