@nx/powerpack-gcs-cache

This package is part of the Nx Powerpack extensions for Nx.

This plugin provides a Nx cache which can be self hosted on Google Cloud Storage.

Usage

Use of this package is governed by the following LICENSE. Please be sure to read through the license carefully before using this plugin. This license is also included in the package in a LICENSE file.

Use Cases

This plugin is useful when Nx Cloud is not a viable solution. Nx Cloud is the ideal recommended method of sharing a cache between multiple machines using Nx.

This plugin uploads and downloads artifacts and metadata to and from a Google Cloud Storage bucket of your choice. This allows Nx to run faster in CI environments by reusing computation done in other runs.

Adding this plugin to your Nx workspace

Use nx add @nx/powerpack-gcs-cache to install and setup this plugin in your Nx workspace.

Configuration

This cache can be configured in an gcs property in nx.json. The following properties are configurable:

| Property | Description | Default | Required | | ---------- | ----------------------------------------------------------------------------------------------------------- | ------- | -------- | | bucket | The name of th Google Cloud Storage bucket to use for the cache. | N/a | Yes | | endpoint | The endpoint where Google Cloud Storage an be reached.(only use if not using the default GCS endpoint) | N/a | No |