A Nx plugin which provides a Nx cache which can be self hosted on Azure Blob Storage.
This plugin provides a Nx cache which can be self hosted
on Azure Blob Storage.
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.
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 an Azure Blob Storage container of your choice.
This allows Nx to run fasterr in CI environments by reusing computation done in other runs.
Use nx add @nx/azure-cache to install and setup this plugin in your Nx workspace.
This cache can be configured in an azure property in nx.json. The following properties are configurable:
| Property | Description | Default | Required |
| ------------- | --------------------------------------------------------------------------------------------- | ------------ | -------- |
| container | The name of th Azure Blob Storage container to use for the cache. | N/a | Yes |
| accountName | Account name associated with the container | N/a | Yes |
| localMode | The mode that the cache behaves as during local development: read, read-write, no-cache | 'read-write' | No |
| ciMode | The mode that the cache behaves as during CI runs: read, read-write, no-cache | 'read-write' | No |