Changelog

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.

18.0.0

Breaking Changes

Nx support starts at 18.0.0
Nx issue https://github.com/nrwl/nx/issues/20689 requires us to set skipLibCheck: true inside the tsconfig.json of nx-remotecache-* packages.

17.1.1

Chore

Update README.md & CHANGELOG.md

17.1.0

Added

Nx Tasks are now available in the callback passed to createCustomRunner. Fixes #30.

Fixed

Prevent call to getSafeRemoteCacheImplementation if both read and write are disabled. Thanks to Charlie Croom.
Fix filter source implementation to work OS independently. Fixes #31.

17.0.0

Breaking Change

Major versioning is now synced to nx.
Nx support now starts at 17.0.0. Thanks to Steven Rathbauer.

Fixed

Nx dev/peer dependency switched from @nx/workspace to nx. Fixes #27. Thanks to Steven Rathbauer.

5.0.1

Fixed

Fixes #26 (local cache artifact in "*" was not been generated on this machine) error.

5.0.0

Breaking Change

Nx support now starts at 16.9.0 (due to breaking internal cache changes).

Fixed

No incorrect files are filtered out anymore. Fixes #23.

4.2.1

Fixed

Fixed zlib: unexpected end of file error for version Node 18. Thanks to stixx200.

4.2.0

Fixed

Support for Nx version 16.6.0+ by removing the machine id from stored artifacts. Thanks to MikeFear.
read and write flags now prioritize environment variables over the nx.json. Thanks to John98Zakaria.

4.1.0

Added

Options read and write now allow to disable reading and writing from / to the remote cache separately. Thanks to rv2673.

4.0.0

Breaking Changes

Nx support now starts at 16.0.0 thanks to gmfun
Note: packages consuming this package might need to set declaration: false in their TSConfig

3.0.0

Breaking Changes

Environment variables now start with NXCACHE_ instead of NX_CACHE_ to prevent leaking credentials

2.0.0

Breaking Changes

Implementation & API is now stream based to reduce memory overhead.
All file system writes are now fully asynchronous.
Filenames are now suffixed to prevent incorrect cache hits with older versions.

1.1.0

Added

Added name task runner option and NXCACHE_NAME env variable to set a custom cache name

1.0.0

Added

Added initEnv(options) function for reading environment variables from .env

0.0.6

Fixed

File copying from .cache to dist works again

Fixed

fs/promises import broken in Node 12 and below

0.0.5

Fixed

fs/promises import broken in Node 12 and below

0.0.4

Fixed

silent option now correctly mutes all info and success logs

0.0.3

Added

silent option to mute info and success logs

0.0.2

Added

Initial implementation of createCustomRunner