Google Cloud Storage Cache Action
GitHub already provides an awesome action to cache your workload to Azure's servers hosted in United States. However, if you are using self-hosted runners hosted far away from the cache location, or if you pay external network way more than internal network, you may want to host your cache elsewhere for better performance and lower costs.
This action does have the same set of inputs as the @actions/cache action from GitHub, in addition to a new bucket input which should contain your target Google Cloud Storage bucket. As simple as that.
Usage
workflow.yml
- name: Authenticate to Google Cloud
uses: google-github-actions/auth@v0
with:
workload_identity_provider: projects/your-project-id/locations/global/workloadIdentityPools/your-identity-pool/providers/your-provider
service_account: [email protected]
- name: Cache the node_modules
id: node-modules-cache
uses: mansagroup/gcs-cache-action@v2
with:
bucket: my-ci-cache
path: node_modules
key: node-modules-${{ runner.os }}-${{ hashFiles('package-lock.json') }}
restore-keys: |
node-modules-${{ runner.os }}-
- name: Install dependencies
if: steps.node-modules-cache.outputs.cache-hit == 'false'
run: npm ci
Inputs
This GitHub action can take several inputs to configure its behaviors:
| Name | Type | Default | Example | Description |
|---|---|---|---|---|
| bucket | String | ø | my-ci-cache |
The name of the Google Cloud Storage bucket to use |
| path | String[] | ø | node_modules |
One or more path to store |
| key | String | ø | node-modules-${{ runner.os }}-${{ hashFiles('package-lock.json') }} |
Key to use as cache name |
| restore-keys | String[] | ø | node-modules-${{ runner.os }}- |
Alternative keys to use when looking for the best cache available |
Note: the path and restore-keys inputs can contains multiple value separated by a new line.
Outputs
This GitHub action will output the following values:
| Name | Type | Description |
|---|---|---|
| cache-hit | String | A boolean string representing if the cache was successfully restored |
Examples
With multiple paths
workflow.yml
- name: Authenticate to Google Cloud
uses: google-github-actions/auth@v0
with:
workload_identity_provider: projects/your-project-id/locations/global/workloadIdentityPools/your-identity-pool/providers/your-provider
service_account: [email protected]
- name: Cache the node_modules and npm cache
id: node-modules-cache
uses: mansagroup/gcs-cache-action@v2
with:
bucket: my-ci-cache
path: |
node_modules
~/.npm
key: npm-and-node-modules-${{ runner.os }}-${{ hashFiles('package-lock.json') }}
restore-keys: |
npm-and-node-modules-${{ runner.os }}-
Compression algorithm
When compressing or decompressing the cache archive, the action will lookup for the best compression algorithm to use. If zstd is available, it will be used instead of gzip by default. The compression method will be added to the object's metadata on the Bucket. Thanks to this, when decompressing, the correct algorithm will be used.
Installing
zstdon Ubuntu is simple as doing aapt install zstd.
Note that if a cache archive was compressed using one algorithm, this same algorithm should be installed to decompress it after.
Terraform
Here is a little snippet allowing you to create your cache bucket with Terraform (which you should probably use):
resource "google_storage_bucket" "ci_cache" {
name = "your-ci-cache"
location = "your-location" # "EUROPE-WEST1"
uniform_bucket_level_access = true
lifecycle_rule {
action {
type = "Delete"
}
condition {
age = 7
}
}
}
resource "google_storage_bucket_iam_member" "ci_cache_write_github_ci" {
bucket = google_storage_bucket.ci_cache.name
role = "roles/storage.objectCreator"
member = "serviceAccount:[email protected]"
}
resource "google_storage_bucket_iam_member" "ci_cache_read_github_ci" {
bucket = google_storage_bucket.ci_cache.name
role = "roles/storage.objectViewer"
member = "serviceAccount:[email protected]"
}
resource "google_storage_bucket_iam_member" "ci_cache_legacy_write_github_ci" {
bucket = google_storage_bucket.ci_cache.name
role = "roles/storage.legacyBucketWriter"
member = "serviceAccount:[email protected]"
}
Q&A
Could I use this action on multiple repositories with the same bucket?
Yes you can. When storing to the bucket, this action will use the following the following path:
[repository owner]/[repository name]/[cache key].tar.gz
License
This project is MIT licensed.
Contributors
Thanks goes to these wonderful people (emoji key):
 Jérémy Levilain |
This project follows the all-contributors specification. Contributions of any kind welcome!
19 Nov 7, 2022
127 Jan 2, 2023
6 Dec 15, 2022
11 Dec 24, 2022
16 Nov 23, 2022
18 Dec 23, 2022
4 Nov 16, 2022
43 Dec 21, 2022
319 Dec 30, 2022
10 Dec 21, 2022
32 Dec 30, 2022
3 Jun 7, 2022
9 Nov 22, 2022
17 Dec 11, 2022
4 Oct 9, 2022
5 Oct 31, 2022
5 Sep 15, 2022
17 Nov 21, 2022