https://github.com/dtinth/setup-github-actions-caching-for-turbo
Action to set up Turborepo Remote Caching to work with GitHub Actions' built-in cache instead of Vercel (codename: turbogha)
https://github.com/dtinth/setup-github-actions-caching-for-turbo
Last synced: 9 months ago
JSON representation
Action to set up Turborepo Remote Caching to work with GitHub Actions' built-in cache instead of Vercel (codename: turbogha)
- Host: GitHub
- URL: https://github.com/dtinth/setup-github-actions-caching-for-turbo
- Owner: dtinth
- License: mit
- Created: 2023-02-04T08:23:52.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-26T06:15:57.000Z (over 1 year ago)
- Last Synced: 2025-03-31T07:09:06.713Z (10 months ago)
- Language: TypeScript
- Homepage:
- Size: 2.37 MB
- Stars: 160
- Watchers: 2
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
> [!NOTE]
> **Users are recommended to use [rharkor/caching-for-turbo](https://github.com/marketplace/actions/caching-for-turborepo) instead.** It is a drop-in replacement, so existing users can migrate easily.
> [!WARNING]
> This action is no longer actively maintained, and there have been [breaking changes to the underlying API](https://github.com/dtinth/setup-github-actions-caching-for-turbo/issues/26#issuecomment-2166446362) that makes this action no longer work.
---
_Original README file contents below:_
The `dtinth/setup-github-actions-caching-for-turbo` action launches a [custom Turborepo Remote Caching Server](https://turbo.build/repo/docs/core-concepts/remote-caching#custom-remote-caches) (codenamed “turbogha”) that leverages [GitHub Actions’ Cache Service API](https://github.com/tonistiigi/go-actions-cache/blob/master/api.md) as a backing storage, and then configures Turborepo to use it.
## How to use
Add this to your GitHub Actions workflow, **before** running `turbo build`.
```yaml
- uses: dtinth/setup-github-actions-caching-for-turbo@v1
```
The action will:
1. Launch a server on `localhost:41230` (and waits for it to be ready).
2. Exports the `TURBO_API`, `TURBO_TOKEN` and `TURBO_TEAM` environment variables for use by `turbo build`.
3. Sets up a post-build step to print the server logs (for debugging).
## Configuration
Configuration is optional. Here are the available options and their default values:
```yaml
with:
# Set the prefix for the cache keys.
cache-prefix: turbogha_
```
## Disclaimer
This project is experimental and is provided as-is. It relies on [GitHub Actions Cache Service API](https://github.com/tonistiigi/go-actions-cache/blob/master/api.md), for which there is no official documentation (however [it’s been used by Docker Build as a cache backend for a long time](https://docs.docker.com/build/cache/backends/gha/)). It is only tested to work with GitHub Actions’ hosted runners running on Linux. Please do not expect that it will be stable or work in all cases. Feel free to open an issue if you have any questions or problems, but I have no plans to provide support beyond my own use cases. If you need this action to work in your use case, you are welcome to fork this project and make changes to suit your needs in accordance with the [MIT License](LICENSE).