Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 2.22 KB

README.md

File metadata and controls

51 lines (32 loc) · 2.22 KB
Raw

TurboRepo Remote Cache GitHub Action

A GitHub action which runs a ducktors/turborepo-remote-cache server in the background so you can use any of the non-local supported storage providers to cache your TurboRepo builds.

Inputs

storage-provider

Required The storage provider to use. Supports all options from environmental variables for more information.

storage-path

Required The name of the bucket to use. Supports all options from environmental variables for more information.

team-id

The Team ID to use. This controls the directory where cache entries will be saved. Default "ci".

host

Used to set the TURBO_API env variable. Default "http://127.0.0.1".

port

Sets the port the server will listen on, and is added to the end of the TURBO_API env variable. When not set, a random free port will be used.

Environment variables

You may also need to set environment variables to provide credentials to the storage provider. See supported storage providers for more information.

Note

If you are familiar with ducktors/turborepo-remote-cache, you may be wondering why there is a lack of other inputs for other environmental variables. The reasons are as follows:

  • "TURBO_TOKEN" - Set automatically by the action to a random secure token on each workflow run.
  • "NODE_ENV", "LOG_LEVEL", "STORAGE_PATH_USE_TMP_FOLDER", and "BODY_LIMIT" - These can be set manually using the env input to the action if needed, but it's not recommended to change them.

Example usage

- name: TurboRepo Remote Cache Server
  uses: trappar/turborepo-remote-cache-gh-action@main
  with:
    storage-provider: s3
    storage-path: my-bucket-name
  env:
    AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
    AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

- name: Run Build
  run: turbo build