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.
Required The storage provider to use. Supports all options from environmental variables for more information.
Required The name of the bucket to use. Supports all options from environmental variables for more information.
The Team ID to use. This controls the directory where cache entries will be saved. Default "ci".
Used to set the TURBO_API env variable. Default "http://127.0.0.1".
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.
Sets interval between checks to see if server is running on port. Defaults to 250ms.
Sets timeout of port checking. If server is not up and running on the port after this period, the action will fail. Defaults to 5000ms.
You may also need to set environment variables to provide credentials to the storage provider. See supported storage providers for more information.
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 theenvinput to the action if needed, but it's not recommended to change them.
- name: TurboRepo Remote Cache Server
uses: trappar/turborepo-remote-cache-gh-action@main
with:
storage-provider: s3
storage-path: my-bucket-name
port-retry-time-ms: 250
port-timeout-ms: 5000
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