The @nx/gcs-cache plugin enables you to self-host your remote cache on Google Cloud Storage.
Self-hosted caching is now free for everyone to use.
Set Up @nx/gcs-cache
1. Install the Package
Run the following command:
❯
nx add @nx/gcs-cache
This will add the @nx/gcs-cache NPM package and automatically configure it for your workspace. As part of this process, you'll be guided to generate a new activation key. This is a fully automated process to register your plugin.
The key will be saved in your repository (.nx/key/key.ini) and should be committed so that every developer has access to it. If your repository is public (or in CI), you can also use an environment variable:
1NX_KEY=YOUR_ACTIVATION_KEY
2Why require an activation key? It simply helps us know and support our users. If you prefer not to provide this information, you can also build your own cache server. Learn more.
2. Authenticate with Google Cloud
There are several ways to authenticate with Google Cloud Storage, but the method recommended by Google is to use Workload Identity Federation, like this:
1name: CI
2...
3permissions:
4 id-token: write
5 ...
6
7jobs:
8 main:
9 env:
10 NX_KEY: ${{ secrets.NX_KEY }}
11 runs-on: ubuntu-latest
12 steps:
13 ...
14
15 - id: 'auth'
16 name: 'Authenticate to Google Cloud'
17 uses: 'google-github-actions/auth@v2'
18 with:
19 token_format: 'access_token'
20 workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider'
21 service_account: 'my-service-account@my-project.iam.gserviceaccount.com'
22
23 - name: 'Set up Cloud SDK'
24 uses: 'google-github-actions/setup-gcloud@v2'
25 with:
26 version: '>= 363.0.0'
27
28 ...
29
30 - run: pnpm exec nx affected -t lint test build
31Note: Any authentication method that sets up the Application Default Credentials will enable the plugin to work.
3. Configure the Nx Cache to Use Google Cloud Storage
Finally, you need to configure your Nx cache in the nx.json file. The bucket that you specify needs to already exist - Nx doesn't create it for you.
1{
2 "gcs": {
3 "bucket": "my-bucket"
4 }
5}
6| Property | Description |
|---|---|
| bucket | The name of the bucket to use |
Migrating from Custom Tasks Runners
Many people who are interested in Nx Powerpack have previously used custom task runners. Nx offers a new and simpler extension API designed to meet the same use cases as the now-deprecated custom task runners.
To learn more about migrating from custom task runners, please refer to this detailed guide.
Cache Modes
By default, Nx will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting localMode to read-only or no-cache in the nx.json file.
1{
2 "gcs": {
3 // ...
4 "localMode": "read-only"
5 }
6}
7The cache mode in CI can also be configured by setting ciMode to read-only or no-cache in the nx.json file. Or by setting NX_POWERPACK_CACHE_MODE to read-only or no-cache in the CI environment.
1{
2 "gcs": {
3 // ...
4 "ciMode": "read-only"
5 }
6}
7