Skip to content

Latest commit

 

History

History
 
 

nx-remotecache-s3

README.md

npm package link

@pellegrims/nx-remotecache-s3

A task runner for @nrwl/nx that uses s3 storage as a remote cache. This enables all team members and CI servers to share a single cache. The concept and benefits of computation caching are explained in the NX documentation.

This package was built with nx-remotecache-custom 🙌

Setup

npm install --save-dev @pellegrims/nx-remotecache-s3
Parameter Description Environment Variable / .env nx.json
Endpoint Optional. The fully qualified endpoint of the webservice. This is only required when using a custom (non-AWS) endpoint. NXCACHE_S3_ENDPOINT endpoint
Bucket Optional. Specify which bucket should be used for storing the cache. NXCACHE_S3_BUCKET bucket
Prefix Optional. Specify prefix path of target object key. NXCACHE_S3_PREFIX prefix
Region Optional. The AWS region to which this client will send requests. NXCACHE_S3_REGION region
Profile Optional. The AWS profile to use to authenticate. NXCACHE_S3_PROFILE profile
Force Path Style Optional. Whether to force path style URLs for S3 objects (e.g., https://s3.amazonaws.com/<bucket>/ instead of https://<bucket>.s3.amazonaws.com/ NXCACHE_S3_FORCE_PATH_STYLE forcePathStyle
Read Only Optional. Disable writing cache to the S3 bucket. This may be useful if you only want to write to the cache from a CI but not localhost. NXCACHE_S3_READ_ONLY readOnly 
{
  "tasksRunnerOptions": {
    "default": {
      "runner": "@pellegrims/nx-remotecache-s3",
      "options": {
        "cacheableOperations": ["build", "test", "lint", "e2e"],
        "endpoint": "https://some-endpoint.com",
        "bucket": "name-of-bucket",
        "prefix": "prefix/",
        "region": "us-west-000",
        "profile": "name-of-aws-profile",
        "forcePathStyle": true,
        "readOnly": false
      }
    }
  }
}

Authentication is handled by @aws-sdk/credential-provider-node, so credentials will be attempted to be found from the following sources (listed in order of precedence):

  • Environment variables exposed via process.env (example: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY)
  • SSO credentials from token cache
  • Web identity token credentials
  • Shared credentials and config ini files
  • The EC2/ECS Instance Metadata Service

Run it 🚀

Running tasks should now show the storage or retrieval from the remote cache:

------------------------------------------------------------------------
Built Angular Package
 - from: /Users/name/example-workspace/libs/example-lib
 - to:   /Users/name/example-workspace/dist/libs/example-lib
------------------------------------------------------------------------
------------------------------------------------------------------------
Stored output to remote cache: s3 storage
Hash: d3d2bea71ea0f3004304c5cc88cf91be50b02bb636ebbdfcc927626fd8edf1ae
------------------------------------------------------------------------

Advanced Configuration

See nx-remotecache-custom.

More Custom Runners

See nx-remotecache-custom.