mirror of https://github.com/actions/cache.git
Update examples.md
Dany Sam
1 month ago
parent
be131183c6
commit
f270d90235
@ -1,714 +1,232 @@
|
|||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
- [Bun](#bun)
|
- [Google Cloud Storage Cache](#google-cloud-storage-cache)
|
||||||
- [C# - NuGet](#c---nuget)
|
- [Basic Example](#basic-example)
|
||||||
- [Clojure - Lein Deps](#clojure---lein-deps)
|
- [Separate Restore/Save Actions](#separate-restoresave-actions)
|
||||||
- [D - DUB](#d---dub)
|
- [Advanced GCS Cache Examples](#advanced-gcs-cache-examples)
|
||||||
- [POSIX](#posix)
|
- [Cross-Repository Caching](#cross-repository-caching)
|
||||||
- [Windows](#windows)
|
- [Using Workload Identity Federation](#using-workload-identity-federation-recommended-for-production)
|
||||||
- [Deno](#deno)
|
- [Language-Specific Caching Examples](#language-specific-caching-examples)
|
||||||
- [Linux](#linux)
|
|
||||||
- [macOS](#macos)
|
|
||||||
- [Windows](#windows-1)
|
|
||||||
- [Elixir - Mix](#elixir---mix)
|
|
||||||
- [Erlang - Rebar3](#erlang--rebar3)
|
|
||||||
- [Go - Modules](#go---modules)
|
|
||||||
- [Linux](#linux-1)
|
|
||||||
- [macOS](#macos-1)
|
|
||||||
- [Windows](#windows-2)
|
|
||||||
- [Haskell - Cabal](#haskell---cabal)
|
|
||||||
- [Haskell - Stack](#haskell---stack)
|
|
||||||
- [Java - Gradle](#java---gradle)
|
|
||||||
- [Java - Maven](#java---maven)
|
|
||||||
- [Node - npm](#node---npm)
|
|
||||||
- [Node - Lerna](#node---lerna)
|
|
||||||
- [Node - Yarn](#node---yarn)
|
|
||||||
- [Node - Yarn 2](#node---yarn-2)
|
|
||||||
- [OCaml/Reason - esy](#ocamlreason---esy)
|
|
||||||
- [PHP - Composer](#php---composer)
|
|
||||||
- [Python - pip](#python---pip)
|
|
||||||
- [Simple example](#simple-example)
|
|
||||||
- [Multiple OS's in a workflow](#multiple-oss-in-a-workflow)
|
|
||||||
- [Multiple OS's in a workflow with a matrix](#multiple-oss-in-a-workflow-with-a-matrix)
|
|
||||||
- [Using pip to get cache location](#using-pip-to-get-cache-location)
|
|
||||||
- [Python - pipenv](#python---pipenv)
|
|
||||||
- [R - renv](#r---renv)
|
|
||||||
- [Ruby - Bundler](#ruby---bundler)
|
|
||||||
- [Rust - Cargo](#rust---cargo)
|
|
||||||
- [Scala - SBT](#scala---sbt)
|
|
||||||
- [Swift, Objective-C - Carthage](#swift-objective-c---carthage)
|
|
||||||
- [Swift, Objective-C - CocoaPods](#swift-objective-c---cocoapods)
|
|
||||||
- [Swift - Swift Package Manager](#swift---swift-package-manager)
|
|
||||||
- [Swift - Mint](#swift---mint)
|
|
||||||
- [* - Bazel](#---bazel)
|
|
||||||
|
|
||||||
## Bun
|
|
||||||
|
|
||||||
```yaml
|
## Google Cloud Storage Cache
|
||||||
- uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
~/.bun/install/cache
|
|
||||||
key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lockb') }}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Windows
|
Using Google Cloud Storage (GCS) as a cache backend provides several advantages:
|
||||||
|
|
||||||
```yaml
|
- **Larger storage**: Store caches beyond GitHub's 10GB repository limit
|
||||||
- uses: actions/cache@v4
|
- **Cross-repository access**: Share caches between different repositories
|
||||||
with:
|
- **Custom retention**: Control cache lifecycle with GCS retention policies
|
||||||
path: |
|
- **Fallback mechanism**: Automatically falls back to GitHub cache if GCS is unavailable
|
||||||
~\.bun
|
|
||||||
key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lockb') }}
|
|
||||||
```
|
|
||||||
|
|
||||||
## C# - NuGet
|
The following examples show how to configure GCS caching in your workflows.
|
||||||
|
|
||||||
Using [NuGet lock files](https://docs.microsoft.com/nuget/consume-packages/package-references-in-project-files#locking-dependencies):
|
### Basic Example
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/cache@v4
|
name: Build with GCS Cache
|
||||||
with:
|
|
||||||
path: ~/.nuget/packages
|
|
||||||
key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-nuget-
|
|
||||||
```
|
|
||||||
|
|
||||||
Depending on the environment, huge packages might be pre-installed in the global cache folder.
|
|
||||||
With `actions/cache@v4` you can now exclude unwanted packages with [exclude pattern](https://github.com/actions/toolkit/tree/main/packages/glob#exclude-patterns)
|
|
||||||
|
|
||||||
```yaml
|
on: push
|
||||||
- uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
~/.nuget/packages
|
|
||||||
!~/.nuget/packages/unwanted
|
|
||||||
key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-nuget-
|
|
||||||
```
|
|
||||||
|
|
||||||
Or you could move the cache folder like below.
|
jobs:
|
||||||
> **Note** This workflow does not work for projects that require files to be placed in user profile package folder
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
```yaml
|
permissions:
|
||||||
env:
|
contents: 'read'
|
||||||
NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages
|
id-token: 'write' # Required for GCP workload identity federation
|
||||||
steps:
|
|
||||||
- uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: ${{ github.workspace }}/.nuget/packages
|
|
||||||
key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-nuget-
|
|
||||||
```
|
|
||||||
|
|
||||||
## Clojure - Lein Deps
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
```yaml
|
# Set up Google Cloud authentication
|
||||||
- name: Cache lein project dependencies
|
- id: auth
|
||||||
uses: actions/cache@v4
|
uses: google-github-actions/auth@v2
|
||||||
with:
|
with:
|
||||||
path: ~/.m2/repository
|
# Using Service Account Key JSON
|
||||||
key: ${{ runner.os }}-clojure-${{ hashFiles('**/project.clj') }}
|
credentials_json: ${{ secrets.GCP_CREDENTIALS }}
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-clojure
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## D - DUB
|
# Alternatively, use Workload Identity Federation (more secure)
|
||||||
|
# workload_identity_provider: ${{ secrets.WIF_PROVIDER }}
|
||||||
|
# service_account: ${{ secrets.WIF_SERVICE_ACCOUNT }}
|
||||||
|
|
||||||
### POSIX
|
- name: Cache Dependencies
|
||||||
|
id: cache-deps
|
||||||
```yaml
|
uses: danySam/gcs-cache@v1
|
||||||
- uses: actions/cache@v4
|
|
||||||
with:
|
with:
|
||||||
path: ~/.dub
|
path: |
|
||||||
key: ${{ runner.os }}-dub-${{ hashFiles('**/dub.selections.json') }}
|
~/.npm
|
||||||
|
node_modules
|
||||||
|
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
|
||||||
restore-keys: |
|
restore-keys: |
|
||||||
${{ runner.os }}-dub-
|
${{ runner.os }}-node-
|
||||||
```
|
gcs-bucket: my-github-cache-bucket
|
||||||
|
|
||||||
### Windows
|
- name: Install Dependencies
|
||||||
|
if: steps.cache-deps.outputs.cache-hit != 'true'
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
```yaml
|
- name: Build
|
||||||
- uses: actions/cache@v4
|
run: npm run build
|
||||||
with:
|
|
||||||
path: ~\AppData\Local\dub
|
|
||||||
key: ${{ runner.os }}-dub-${{ hashFiles('**/dub.selections.json') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-dub-
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Deno
|
### Separate Restore/Save Actions
|
||||||
|
|
||||||
### Linux
|
For more flexible control, you can use the `restore` and `save` actions separately:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/cache@v4
|
name: Build with GCS Cache (Separate Restore/Save)
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
~/.deno
|
|
||||||
~/.cache/deno
|
|
||||||
key: ${{ runner.os }}-deno-${{ hashFiles('**/deps.ts') }}
|
|
||||||
```
|
|
||||||
|
|
||||||
### macOS
|
on: push
|
||||||
|
|
||||||
```yaml
|
jobs:
|
||||||
- uses: actions/cache@v4
|
build:
|
||||||
with:
|
runs-on: ubuntu-latest
|
||||||
path: |
|
|
||||||
~/.deno
|
|
||||||
~/Library/Caches/deno
|
|
||||||
key: ${{ runner.os }}-deno-${{ hashFiles('**/deps.ts') }}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Windows
|
permissions:
|
||||||
|
contents: 'read'
|
||||||
|
id-token: 'write' # Required for GCP workload identity federation
|
||||||
|
|
||||||
```yaml
|
steps:
|
||||||
- uses: actions/cache@v4
|
- uses: actions/checkout@v4
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
~\.deno
|
|
||||||
~\AppData\Local\deno
|
|
||||||
key: ${{ runner.os }}-deno-${{ hashFiles('**/deps.ts') }}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Elixir - Mix
|
|
||||||
|
|
||||||
```yaml
|
# Set up Google Cloud authentication
|
||||||
- uses: actions/cache@v4
|
- id: auth
|
||||||
|
uses: google-github-actions/auth@v2
|
||||||
with:
|
with:
|
||||||
path: |
|
credentials_json: ${{ secrets.GCP_CREDENTIALS }}
|
||||||
deps
|
# Or use workload identity federation
|
||||||
_build
|
|
||||||
key: ${{ runner.os }}-mix-${{ hashFiles('**/mix.lock') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-mix-
|
|
||||||
```
|
|
||||||
|
|
||||||
## Erlang - Rebar3
|
- name: Restore Dependencies from Cache
|
||||||
```yaml
|
id: cache-deps-restore
|
||||||
- uses: actions/cache@v2
|
uses: danySam/gcs-cache/restore@v1
|
||||||
with:
|
with:
|
||||||
path: |
|
path: |
|
||||||
~/.cache/rebar3
|
~/.npm
|
||||||
_build
|
node_modules
|
||||||
key: ${{ runner.os }}-erlang-${{ env.OTP_VERSION }}-${{ hashFiles('**/*rebar.lock') }}
|
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
|
||||||
restore-keys: |
|
restore-keys: |
|
||||||
${{ runner.os }}-erlang-${{ env.OTP_VERSION }}-
|
${{ runner.os }}-node-
|
||||||
```
|
gcs-bucket: my-github-cache-bucket
|
||||||
|
|
||||||
## Go - Modules
|
- name: Install Dependencies
|
||||||
|
if: steps.cache-deps-restore.outputs.cache-hit != 'true'
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
### Linux
|
- name: Build
|
||||||
|
run: npm run build
|
||||||
|
|
||||||
```yaml
|
- name: Save Dependencies to Cache
|
||||||
- uses: actions/cache@v4
|
id: cache-deps-save
|
||||||
|
uses: danySam/gcs-cache/save@v1
|
||||||
with:
|
with:
|
||||||
path: |
|
path: |
|
||||||
~/.cache/go-build
|
~/.npm
|
||||||
~/go/pkg/mod
|
node_modules
|
||||||
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
|
key: ${{ steps.cache-deps-restore.outputs.cache-primary-key }}
|
||||||
restore-keys: |
|
gcs-bucket: my-github-cache-bucket
|
||||||
${{ runner.os }}-go-
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### macOS
|
### Advanced GCS Cache Examples
|
||||||
|
|
||||||
```yaml
|
#### Cross-Repository Caching
|
||||||
- uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
~/Library/Caches/go-build
|
|
||||||
~/go/pkg/mod
|
|
||||||
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-go-
|
|
||||||
```
|
|
||||||
|
|
||||||
### Windows
|
Share caches across multiple repositories using the same GCS bucket:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/cache@v4
|
name: Build with Shared GCS Cache
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
~\AppData\Local\go-build
|
|
||||||
~\go\pkg\mod
|
|
||||||
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-go-
|
|
||||||
```
|
|
||||||
|
|
||||||
## Haskell - Cabal
|
on: push
|
||||||
|
|
||||||
We cache the elements of the Cabal store separately, as the entirety of `~/.cabal` can grow very large for projects with many dependencies.
|
jobs:
|
||||||
|
build:
|
||||||
```yaml
|
runs-on: ubuntu-latest
|
||||||
- name: Cache ~/.cabal/packages, ~/.cabal/store and dist-newstyle
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
~/.cabal/packages
|
|
||||||
~/.cabal/store
|
|
||||||
dist-newstyle
|
|
||||||
key: ${{ runner.os }}-${{ matrix.ghc }}-${{ hashFiles('**/*.cabal', '**/cabal.project', '**/cabal.project.freeze') }}
|
|
||||||
restore-keys: ${{ runner.os }}-${{ matrix.ghc }}-
|
|
||||||
```
|
|
||||||
|
|
||||||
## Haskell - Stack
|
permissions:
|
||||||
|
contents: 'read'
|
||||||
|
id-token: 'write'
|
||||||
|
|
||||||
### Linux or macOS
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
```yaml
|
# Set up Google Cloud authentication
|
||||||
- uses: actions/cache@v4
|
- uses: google-github-actions/auth@v2
|
||||||
name: Cache ~/.stack
|
|
||||||
with:
|
|
||||||
path: ~/.stack
|
|
||||||
key: ${{ runner.os }}-stack-global-${{ hashFiles('stack.yaml') }}-${{ hashFiles('package.yaml') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-stack-global-
|
|
||||||
- uses: actions/cache@v4
|
|
||||||
name: Cache .stack-work
|
|
||||||
with:
|
with:
|
||||||
path: .stack-work
|
credentials_json: ${{ secrets.GCP_CREDENTIALS }}
|
||||||
key: ${{ runner.os }}-stack-work-${{ hashFiles('stack.yaml') }}-${{ hashFiles('package.yaml') }}-${{ hashFiles('**/*.hs') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-stack-work-
|
|
||||||
```
|
|
||||||
|
|
||||||
### Windows
|
|
||||||
|
|
||||||
```yaml
|
- name: Shared Cross-Repo Cache
|
||||||
- uses: actions/cache@v4
|
id: shared-cache
|
||||||
name: Cache %APPDATA%\stack %LOCALAPPDATA%\Programs\stack
|
uses: danySam/gcs-cache@v1
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
~\AppData\Roaming\stack
|
|
||||||
~\AppData\Local\Programs\stack
|
|
||||||
key: ${{ runner.os }}-stack-global-${{ hashFiles('stack.yaml') }}-${{ hashFiles('package.yaml') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-stack-global-
|
|
||||||
- uses: actions/cache@v4
|
|
||||||
name: Cache .stack-work
|
|
||||||
with:
|
|
||||||
path: .stack-work
|
|
||||||
key: ${{ runner.os }}-stack-work-${{ hashFiles('stack.yaml') }}-${{ hashFiles('package.yaml') }}-${{ hashFiles('**/*.hs') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-stack-work-
|
|
||||||
```
|
|
||||||
|
|
||||||
## Java - Gradle
|
|
||||||
|
|
||||||
> **Note** Ensure no Gradle daemons are running anymore when your workflow completes. Creating the cache package might fail due to locks being held by Gradle. Refer to the [Gradle Daemon documentation](https://docs.gradle.org/current/userguide/gradle_daemon.html) on how to disable or stop the Gradle Daemons.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: actions/cache@v4
|
|
||||||
with:
|
with:
|
||||||
path: |
|
path: |
|
||||||
~/.gradle/caches
|
~/.gradle/caches
|
||||||
~/.gradle/wrapper
|
~/.gradle/wrapper
|
||||||
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
key: shared-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-gradle-
|
|
||||||
```
|
|
||||||
|
|
||||||
## Java - Maven
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- name: Cache local Maven repository
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: ~/.m2/repository
|
|
||||||
key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-maven-
|
|
||||||
```
|
|
||||||
|
|
||||||
## Node - npm
|
|
||||||
|
|
||||||
For npm, cache files are stored in `~/.npm` on Posix, or `~\AppData\npm-cache` on Windows, but it's possible to use `npm config get cache` to find the path on any platform. See [the npm docs](https://docs.npmjs.com/cli/cache#cache) for more details.
|
|
||||||
|
|
||||||
If using `npm config` to retrieve the cache directory, ensure you run [actions/setup-node](https://github.com/actions/setup-node) first to ensure your `npm` version is correct.
|
|
||||||
After [deprecation](https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/) of save-state and set-output commands, the correct way to set output is using `${GITHUB_OUTPUT}`. For linux, we can use `${GITHUB_OUTPUT}` whereas for windows we need to use `${env:GITHUB_OUTPUT}` due to two different default shells in these two different OS ie `bash` and `pwsh` respectively.
|
|
||||||
|
|
||||||
> **Note** It is not recommended to cache `node_modules`, as it can break across Node versions and won't work with `npm ci`
|
|
||||||
|
|
||||||
### **Get npm cache directory using same shell**
|
|
||||||
### Bash shell
|
|
||||||
```yaml
|
|
||||||
- name: Get npm cache directory
|
|
||||||
id: npm-cache-dir
|
|
||||||
shell: bash
|
|
||||||
run: echo "dir=$(npm config get cache)" >> ${GITHUB_OUTPUT}
|
|
||||||
```
|
|
||||||
|
|
||||||
### PWSH shell
|
|
||||||
```yaml
|
|
||||||
- name: Get npm cache directory
|
|
||||||
id: npm-cache-dir
|
|
||||||
shell: pwsh
|
|
||||||
run: echo "dir=$(npm config get cache)" >> ${env:GITHUB_OUTPUT}
|
|
||||||
```
|
|
||||||
`Get npm cache directory` step can then be used with `actions/cache` as shown below
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: actions/cache@v4
|
|
||||||
id: npm-cache # use this to check for `cache-hit` ==> if: steps.npm-cache.outputs.cache-hit != 'true'
|
|
||||||
with:
|
|
||||||
path: ${{ steps.npm-cache-dir.outputs.dir }}
|
|
||||||
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-node-
|
|
||||||
```
|
|
||||||
|
|
||||||
## Node - Lerna
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- name: restore lerna
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: '**/node_modules'
|
|
||||||
key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Node - Yarn
|
|
||||||
The yarn cache directory will depend on your operating system and version of `yarn`. See https://yarnpkg.com/lang/en/docs/cli/cache/ for more info.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- name: Get yarn cache directory path
|
|
||||||
id: yarn-cache-dir-path
|
|
||||||
run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
|
|
||||||
|
|
||||||
- uses: actions/cache@v4
|
|
||||||
id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
|
|
||||||
with:
|
|
||||||
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
|
|
||||||
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
|
|
||||||
restore-keys: |
|
restore-keys: |
|
||||||
${{ runner.os }}-yarn-
|
shared-gradle-
|
||||||
```
|
gcs-bucket: shared-company-cache-bucket
|
||||||
|
gcs-path-prefix: gradle-cache # Optional: organize caches in the bucket
|
||||||
## Node - Yarn 2
|
|
||||||
|
|
||||||
The yarn 2 cache directory will depend on your config. See https://yarnpkg.com/configuration/yarnrc#cacheFolder for more info.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- name: Get yarn cache directory path
|
|
||||||
id: yarn-cache-dir-path
|
|
||||||
run: echo "dir=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT
|
|
||||||
|
|
||||||
- uses: actions/cache@v4
|
# Rest of your workflow
|
||||||
id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
|
|
||||||
with:
|
|
||||||
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
|
|
||||||
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-yarn-
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## OCaml/Reason - esy
|
#### Using Workload Identity Federation (Recommended for Production)
|
||||||
|
|
||||||
Esy allows you to export built dependencies and import pre-built dependencies.
|
|
||||||
```yaml
|
|
||||||
- name: Restore Cache
|
|
||||||
id: restore-cache
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: _export
|
|
||||||
key: ${{ runner.os }}-esy-${{ hashFiles('esy.lock/index.json') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-esy-
|
|
||||||
- name: Esy install
|
|
||||||
run: 'esy install'
|
|
||||||
- name: Import Cache
|
|
||||||
run: |
|
|
||||||
esy import-dependencies _export
|
|
||||||
rm -rf _export
|
|
||||||
|
|
||||||
...(Build job)...
|
|
||||||
|
|
||||||
# Re-export dependencies if anything has changed or if it is the first time
|
|
||||||
- name: Setting dependency cache
|
|
||||||
run: |
|
|
||||||
esy export-dependencies
|
|
||||||
if: steps.restore-cache.outputs.cache-hit != 'true'
|
|
||||||
```
|
|
||||||
|
|
||||||
## PHP - Composer
|
For production environments, Google recommends [Workload Identity Federation](https://cloud.google.com/iam/docs/workload-identity-federation) over service account keys for more secure authentication. This approach eliminates the need to manage long-lived service account keys:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- name: Get Composer Cache Directory
|
name: Build with GCS Cache using Workload Identity
|
||||||
id: composer-cache
|
|
||||||
run: |
|
|
||||||
echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
|
|
||||||
- uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: ${{ steps.composer-cache.outputs.dir }}
|
|
||||||
key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-composer-
|
|
||||||
```
|
|
||||||
|
|
||||||
## Python - pip
|
|
||||||
|
|
||||||
For pip, the cache directory will vary by OS. See https://pip.pypa.io/en/stable/reference/pip_install/#caching
|
|
||||||
|
|
||||||
Locations:
|
on: push
|
||||||
|
|
||||||
- Ubuntu: `~/.cache/pip`
|
|
||||||
- Windows: `~\AppData\Local\pip\Cache`
|
|
||||||
- macOS: `~/Library/Caches/pip`
|
|
||||||
|
|
||||||
### Simple example
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: ~/.cache/pip
|
|
||||||
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-pip-
|
|
||||||
```
|
|
||||||
|
|
||||||
Replace `~/.cache/pip` with the correct `path` if not using Ubuntu.
|
|
||||||
|
|
||||||
### Multiple OS's in a workflow
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: actions/cache@v4
|
|
||||||
if: startsWith(runner.os, 'Linux')
|
|
||||||
with:
|
|
||||||
path: ~/.cache/pip
|
|
||||||
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-pip-
|
|
||||||
|
|
||||||
- uses: actions/cache@v4
|
|
||||||
if: startsWith(runner.os, 'macOS')
|
|
||||||
with:
|
|
||||||
path: ~/Library/Caches/pip
|
|
||||||
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-pip-
|
|
||||||
|
|
||||||
- uses: actions/cache@v4
|
|
||||||
if: startsWith(runner.os, 'Windows')
|
|
||||||
with:
|
|
||||||
path: ~\AppData\Local\pip\Cache
|
|
||||||
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-pip-
|
|
||||||
```
|
|
||||||
|
|
||||||
### Multiple OS's in a workflow with a matrix
|
|
||||||
|
|
||||||
``` yaml
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
os: [ubuntu-latest, macos-latest, windows-latest]
|
|
||||||
include:
|
|
||||||
- os: ubuntu-latest
|
|
||||||
path: ~/.cache/pip
|
|
||||||
- os: macos-latest
|
|
||||||
path: ~/Library/Caches/pip
|
|
||||||
- os: windows-latest
|
|
||||||
path: ~\AppData\Local\pip\Cache
|
|
||||||
steps:
|
|
||||||
- uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: ${{ matrix.path }}
|
|
||||||
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-pip-
|
|
||||||
```
|
|
||||||
|
|
||||||
### Using pip to get cache location
|
|
||||||
|
|
||||||
> **Note** This requires pip 20.1+
|
|
||||||
```yaml
|
|
||||||
- name: Get pip cache dir
|
|
||||||
id: pip-cache
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
|
|
||||||
|
|
||||||
- name: pip cache
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: ${{ steps.pip-cache.outputs.dir }}
|
|
||||||
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-pip-
|
|
||||||
```
|
|
||||||
|
|
||||||
## Python - pipenv
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- name: Set up Python
|
|
||||||
# The actions/cache step below uses this id to get the exact python version
|
|
||||||
id: setup-python
|
|
||||||
uses: actions/setup-python@v2
|
|
||||||
|
|
||||||
⋮
|
|
||||||
|
|
||||||
- uses: actions/cache@v4
|
permissions:
|
||||||
with:
|
contents: 'read'
|
||||||
path: ~/.local/share/virtualenvs
|
id-token: 'write' # Required for Workload Identity Federation
|
||||||
key: ${{ runner.os }}-python-${{ steps.setup-python.outputs.python-version }}-pipenv-${{ hashFiles('Pipfile.lock') }}
|
|
||||||
```
|
|
||||||
|
|
||||||
## R - renv
|
|
||||||
|
|
||||||
For renv, the cache directory will vary by OS. The `RENV_PATHS_ROOT` environment variable is used to set the cache location. Have a look at https://rstudio.github.io/renv/reference/paths.html#details for more details.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- name: Set RENV_PATHS_ROOT
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
echo "RENV_PATHS_ROOT=${{ runner.temp }}/renv" >> $GITHUB_ENV
|
|
||||||
- name: Install and activate renv
|
|
||||||
run: |
|
|
||||||
install.packages("renv")
|
|
||||||
renv::activate()
|
|
||||||
shell: Rscript {0}
|
|
||||||
- name: Get R and OS version
|
|
||||||
id: get-version
|
|
||||||
run: |
|
|
||||||
cat("##[set-output name=os-version;]", sessionInfo()$running, "\n", sep = "")
|
|
||||||
cat("##[set-output name=r-version;]", R.Version()$version.string, sep = "")
|
|
||||||
shell: Rscript {0}
|
|
||||||
- name: Restore Renv package cache
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: ${{ env.RENV_PATHS_ROOT }}
|
|
||||||
key: ${{ steps.get-version.outputs.os-version }}-${{ steps.get-version.outputs.r-version }}-${{ inputs.cache-version }}-${{ hashFiles('renv.lock') }}
|
|
||||||
restore-keys: ${{ steps.get-version.outputs.os-version }}-${{ steps.get-version.outputs.r-version }}-${{inputs.cache-version }}-
|
|
||||||
```
|
|
||||||
|
|
||||||
## Ruby - Bundler
|
|
||||||
|
|
||||||
Caching gems with Bundler correctly is not trivial and just using `actions/cache`
|
|
||||||
is [not enough](https://github.com/ruby/setup-ruby#caching-bundle-install-manually).
|
|
||||||
|
|
||||||
Instead, it is recommended to use `ruby/setup-ruby`'s
|
|
||||||
[`bundler-cache: true` option](https://github.com/ruby/setup-ruby#caching-bundle-install-automatically)
|
|
||||||
whenever possible:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: ruby/setup-ruby@v1
|
|
||||||
with:
|
|
||||||
ruby-version: ...
|
|
||||||
bundler-cache: true
|
|
||||||
```
|
|
||||||
|
|
||||||
## Rust - Cargo
|
|
||||||
|
|
||||||
```yaml
|
steps:
|
||||||
- uses: actions/cache@v4
|
- uses: actions/checkout@v4
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
~/.cargo/bin/
|
|
||||||
~/.cargo/registry/index/
|
|
||||||
~/.cargo/registry/cache/
|
|
||||||
~/.cargo/git/db/
|
|
||||||
target/
|
|
||||||
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Scala - SBT
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- name: Cache SBT
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
~/.ivy2/cache
|
|
||||||
~/.sbt
|
|
||||||
key: ${{ runner.os }}-sbt-${{ hashFiles('**/build.sbt') }}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Swift, Objective-C - Carthage
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: Carthage
|
|
||||||
key: ${{ runner.os }}-carthage-${{ hashFiles('**/Cartfile.resolved') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-carthage-
|
|
||||||
```
|
|
||||||
|
|
||||||
## Swift, Objective-C - CocoaPods
|
|
||||||
|
|
||||||
```yaml
|
# Set up Google Cloud authentication with Workload Identity Federation
|
||||||
- uses: actions/cache@v4
|
- id: auth
|
||||||
|
uses: google-github-actions/auth@v2
|
||||||
with:
|
with:
|
||||||
path: Pods
|
# The workload identity provider resource name
|
||||||
key: ${{ runner.os }}-pods-${{ hashFiles('**/Podfile.lock') }}
|
workload_identity_provider: projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider
|
||||||
restore-keys: |
|
# The service account email address
|
||||||
${{ runner.os }}-pods-
|
service_account: my-service-account@my-project.iam.gserviceaccount.com
|
||||||
```
|
# Optional: Create credentials file for Google Cloud SDK
|
||||||
|
create_credentials_file: true
|
||||||
## Swift - Swift Package Manager
|
# Optional: Cleanup credentials after job completion
|
||||||
|
cleanup_credentials: true
|
||||||
|
|
||||||
```yaml
|
- name: Cache Dependencies
|
||||||
- uses: actions/cache@v4
|
id: cache-deps
|
||||||
|
uses: danySam/gcs-cache@v1
|
||||||
with:
|
with:
|
||||||
path: .build
|
path: path/to/dependencies
|
||||||
key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved') }}
|
key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
|
||||||
restore-keys: |
|
gcs-bucket: my-github-cache-bucket
|
||||||
${{ runner.os }}-spm-
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Swift - Mint
|
For detailed setup instructions, see the [Google GitHub Actions Auth documentation](https://github.com/google-github-actions/auth). The basic steps include:
|
||||||
|
|
||||||
```yaml
|
1. Create a Workload Identity Pool and Provider in Google Cloud
|
||||||
env:
|
2. Configure IAM permissions for your service account
|
||||||
MINT_PATH: .mint/lib
|
3. Store configuration values in GitHub Secrets
|
||||||
MINT_LINK_PATH: .mint/bin
|
4. Add the auth action to your workflow with proper permissions
|
||||||
steps:
|
|
||||||
- uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: .mint
|
|
||||||
key: ${{ runner.os }}-mint-${{ hashFiles('**/Mintfile') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-mint-
|
|
||||||
```
|
|
||||||
|
|
||||||
## * - Bazel
|
Using Workload Identity Federation provides enhanced security since:
|
||||||
|
- No long-lived credentials need to be stored as GitHub Secrets
|
||||||
|
- Access is temporary and scoped to just the running workflow
|
||||||
|
- All access is fully auditable in Google Cloud logs
|
||||||
|
|
||||||
[`bazelisk`](https://github.com/bazelbuild/bazelisk) does not have be to separately downloaded and installed because it's already included in GitHub's `ubuntu-latest` and `macos-latest` base images.
|
## Language-Specific Caching Examples
|
||||||
|
|
||||||
### Linux
|
- [Bun](#bun)
|
||||||
|
- [C# - NuGet](#c---nuget)
|
||||||
```yaml
|
- [Clojure - Lein Deps](#clojure---lein-deps)
|
||||||
- name: Cache Bazel
|
- [D - DUB](#d---dub)
|
||||||
uses: actions/cache@v4
|
- [POSIX](#posix)
|
||||||
with:
|
- [Windows](#windows)
|
||||||
path: |
|
|
||||||
~/.cache/bazel
|
|
||||||
key: ${{ runner.os }}-bazel-${{ hashFiles('.bazelversion', '.bazelrc', 'WORKSPACE', 'WORKSPACE.bazel', 'MODULE.bazel') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-bazel-
|
|
||||||
- run: bazelisk test //...
|
|
||||||
```
|
|
||||||
|
|
||||||
### macOS
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- name: Cache Bazel
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
/private/var/tmp/_bazel_runner/
|
|
||||||
key: ${{ runner.os }}-bazel-${{ hashFiles('.bazelversion', '.bazelrc', 'WORKSPACE', 'WORKSPACE.bazel', 'MODULE.bazel') }}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-bazel-
|
|
||||||
- run: bazelisk test //...
|
|
||||||
```
|
|
||||||
|
|||||||
Loading…
Reference in New Issue