toolkit/packages/cache/RELEASES.md

# @actions/cache Releases

### 0.1.0

- Initial release

### 0.2.0

- Fixes issues with the zstd compression algorithm on Windows and Ubuntu 16.04 [#469](https://github.com/actions/toolkit/pull/469)

### 0.2.1

- Fix to await async function getCompressionMethod

### 1.0.0

- Downloads Azure-hosted caches using the Azure SDK for speed and reliability
- Displays download progress
- Includes changes that break compatibility with earlier versions, including:
  - `retry`, `retryTypedResponse`, and `retryHttpClientResponse` moved from `cacheHttpClient` to `requestUtils`

### 1.0.1

- Fix bug in downloading large files (> 2 GBs) with the Azure SDK

### 1.0.2

- Use posix archive format to add support for some tools

### 1.0.3

- Use http-client v1.0.9
- Fixes error handling so retries are not attempted on non-retryable errors (409 Conflict, for example)
- Adds 5 second delay between retry attempts

### 1.0.4

- Use @actions/core v1.2.6
- Fixes uploadChunk to throw an error if any unsuccessful response code is received

### 1.0.5

- Fix to ensure Windows cache paths get resolved correctly

### 1.0.6

- Make caching more verbose [#650](https://github.com/actions/toolkit/pull/650)
- Use GNU tar on macOS if available [#701](https://github.com/actions/toolkit/pull/701)

### 1.0.7

- Fixes permissions issue extracting archives with GNU tar on macOS ([issue](https://github.com/actions/cache/issues/527))

### 1.0.8

- Increase the allowed artifact cache size from 5GB to 10GB ([issue](https://github.com/actions/cache/discussions/497))

### 1.0.9

- Use @azure/ms-rest-js v2.6.0
- Use @azure/storage-blob v12.8.0

### 1.0.10

- Update `lockfileVersion` to `v2` in `package-lock.json [#1022](https://github.com/actions/toolkit/pull/1022)

### 1.0.11

- Fix file downloads > 2GB([issue](https://github.com/actions/cache/issues/773))

### 2.0.0

- Added support to check if Actions cache service feature is available or not [#1028](https://github.com/actions/toolkit/pull/1028)

### 2.0.3

- Update to v2.0.0 of `@actions/http-client`

### 2.0.4

- Update to v2.0.1 of `@actions/http-client` [#1087](https://github.com/actions/toolkit/pull/1087)

### 2.0.5

- Fix to avoid saving empty cache when no files are available for caching. ([issue](https://github.com/actions/cache/issues/624))

### 2.0.6

- Fix `Tar failed with error: The process '/usr/bin/tar' failed with exit code 1` issue when temp directory where tar is getting created is actually the subdirectory of the path mentioned by the user for caching. ([issue](https://github.com/actions/cache/issues/689))

### 3.0.0

- Updated actions/cache to suppress Actions cache server error and log warning for those error  [#1122](https://github.com/actions/toolkit/pull/1122)

### 3.0.1

- Fix [#833](https://github.com/actions/cache/issues/833) - cache doesn't work with github workspace directory.
- Fix [#809](https://github.com/actions/cache/issues/809) `zstd -d: no such file or directory` error on AWS self-hosted runners.

### 3.0.2

- Added 1 hour timeout for the download stuck issue [#810](https://github.com/actions/cache/issues/810).

### 3.0.3

- Bug fixes for download stuck issue [#810](https://github.com/actions/cache/issues/810).

### 3.0.4

- Fix zstd not working for windows on gnu tar in issues [#888](https://github.com/actions/cache/issues/888) and [#891](https://github.com/actions/cache/issues/891).
- Allowing users to provide a custom timeout as input for aborting download of a cache segment using an environment variable `SEGMENT_DOWNLOAD_TIMEOUT_MINS`. Default is 60 minutes.

### 3.0.5

- Update `@actions/cache` to use `@actions/core@^1.10.0`

### 3.0.6

- Added `@azure/abort-controller` to dependencies to fix compatibility issue with ESM [#1208](https://github.com/actions/toolkit/issues/1208)

### 3.1.0-beta.1

- Update actions/cache on windows to use gnu tar and zstd by default and fallback to bsdtar and zstd if gnu tar is not available. ([issue](https://github.com/actions/cache/issues/984))

### 3.1.0-beta.2

- Added support for fallback to gzip to restore old caches on windows.

### 3.1.0-beta.3

- Bug Fixes for fallback to gzip to restore old caches on windows and bsdtar if gnutar is not available.

### 3.1.0

- Update actions/cache on windows to use gnu tar and zstd by default
- Update actions/cache on windows to fallback to bsdtar and zstd if gnu tar is not available.
- Added support for fallback to gzip to restore old caches on windows.

### 3.1.1

- Reverted changes in 3.1.0 to fix issue with symlink restoration on windows.
- Added support for verbose logging about cache version during cache miss.

### 3.1.2

- Fix issue with symlink restoration on windows.

### 3.1.3

- Fix to prevent from setting MYSYS environement variable globally [#1329](https://github.com/actions/toolkit/pull/1329).

### 3.1.4

- Fix zstd not being used due to `zstd --version` output change in zstd 1.5.4 release. See [#1353](https://github.com/actions/toolkit/pull/1353).

### 3.2.0

- Add `lookupOnly` to cache restore `DownloadOptions`.

### 3.2.1

- Updated @azure/storage-blob to `v12.13.0`

### 3.2.2

- Add new default cache download method to improve performance and reduce hangs [#1484](https://github.com/actions/toolkit/pull/1484)
Initial commit to create @actions/cache package 2020-05-06 15:10:18 +00:00			`# @actions/cache Releases`

React to feedback 2020-05-15 16:18:50 +00:00			`### 0.1.0`
Initial commit to create @actions/cache package 2020-05-06 15:10:18 +00:00
Bump cache package version 2020-05-19 16:59:38 +00:00			`- Initial release`

Add section for 0.2.1 2020-05-19 20:36:18 +00:00			`### 0.2.0`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Add section for 0.2.1 2020-05-19 20:36:18 +00:00			`- Fixes issues with the zstd compression algorithm on Windows and Ubuntu 16.04 [#469](https://github.com/actions/toolkit/pull/469)`

Fix a bug with getCompressionMethod 2020-05-19 20:12:28 +00:00			`### 0.2.1`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Use Azure storage SDK to download cache (#497) * Adds option to download using AzCopy * Bump version number and add release notes * Ensure we use at least v10 * Negate env var so it disables AzCopy * Use Azure storage SDK to download cache * Use same level of parallelism as AzCopy * Fix naming of variable * React to feedback * Bump Node types to Node 12 * Make linter happy * Pass options into restoreCache method * Fix tests * Restructure files and add tests * Add method to get the default download and upload options * Include breaking changes in RELEASES.md Co-authored-by: Josh Gross <joshmgross@github.com> 2020-07-10 15:09:32 +00:00			`- Fix to await async function getCompressionMethod`

			`### 1.0.0`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Use Azure storage SDK to download cache (#497) * Adds option to download using AzCopy * Bump version number and add release notes * Ensure we use at least v10 * Negate env var so it disables AzCopy * Use Azure storage SDK to download cache * Use same level of parallelism as AzCopy * Fix naming of variable * React to feedback * Bump Node types to Node 12 * Make linter happy * Pass options into restoreCache method * Fix tests * Restructure files and add tests * Add method to get the default download and upload options * Include breaking changes in RELEASES.md Co-authored-by: Josh Gross <joshmgross@github.com> 2020-07-10 15:09:32 +00:00			`- Downloads Azure-hosted caches using the Azure SDK for speed and reliability`
Display download progress 2020-06-20 21:53:27 +00:00			`- Displays download progress`
Use Azure storage SDK to download cache (#497) * Adds option to download using AzCopy * Bump version number and add release notes * Ensure we use at least v10 * Negate env var so it disables AzCopy * Use Azure storage SDK to download cache * Use same level of parallelism as AzCopy * Fix naming of variable * React to feedback * Bump Node types to Node 12 * Make linter happy * Pass options into restoreCache method * Fix tests * Restructure files and add tests * Add method to get the default download and upload options * Include breaking changes in RELEASES.md Co-authored-by: Josh Gross <joshmgross@github.com> 2020-07-10 15:09:32 +00:00			`- Includes changes that break compatibility with earlier versions, including:`
Fix bug downloading large files with the Azure SDK 2020-07-20 20:19:26 +00:00			- `retry`, `retryTypedResponse`, and `retryHttpClientResponse` moved from `cacheHttpClient` to `requestUtils`

			`### 1.0.1`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Use posix archive format (#533) * Use posix archive format Signed-off-by: Sora Morimoto <sora@morimoto.io> * Update package.json and RELEASES.md Signed-off-by: Sora Morimoto <sora@morimoto.io> 2020-08-05 15:17:23 +00:00			`- Fix bug in downloading large files (> 2 GBs) with the Azure SDK`

			`### 1.0.2`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Use posix archive format (#533) * Use posix archive format Signed-off-by: Sora Morimoto <sora@morimoto.io> * Update package.json and RELEASES.md Signed-off-by: Sora Morimoto <sora@morimoto.io> 2020-08-05 15:17:23 +00:00			`- Use posix archive format to add support for some tools`
Update package version and release notes 2020-10-12 18:47:24 +00:00
			`### 1.0.3`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Update package version and release notes 2020-10-12 18:47:24 +00:00			`- Use http-client v1.0.9`
			`- Fixes error handling so retries are not attempted on non-retryable errors (409 Conflict, for example)`
			`- Adds 5 second delay between retry attempts`
Bump @actions/cache to 1.0.4 2020-11-03 19:12:34 +00:00
			`### 1.0.4`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Bump @actions/cache to 1.0.4 2020-11-03 19:12:34 +00:00			`- Use @actions/core v1.2.6`
			`- Fixes uploadChunk to throw an error if any unsuccessful response code is received`
Fix windows cache path 2020-12-10 15:59:04 +00:00
			`### 1.0.5`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
actions/cache 1.0.6 release (#705) 2021-02-02 19:48:46 +00:00			`- Fix to ensure Windows cache paths get resolved correctly`

			`### 1.0.6`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
actions/cache 1.0.6 release (#705) 2021-02-02 19:48:46 +00:00			`- Make caching more verbose [#650](https://github.com/actions/toolkit/pull/650)`
Update RELEASES.md 2021-04-09 19:23:05 +00:00			`- Use GNU tar on macOS if available [#701](https://github.com/actions/toolkit/pull/701)`

			`### 1.0.7`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Update RELEASES.md 2021-04-09 19:23:05 +00:00			`- Fixes permissions issue extracting archives with GNU tar on macOS ([issue](https://github.com/actions/cache/issues/527))`
Cache: Increasing client validation to 10GB (#934) * increasing client validation limit in cache package to 10gb 2021-11-19 11:04:33 +00:00
			`### 1.0.8`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Cache: Increasing client validation to 10GB (#934) * increasing client validation limit in cache package to 10gb 2021-11-19 11:04:33 +00:00			`- Increase the allowed artifact cache size from 5GB to 10GB ([issue](https://github.com/actions/cache/discussions/497))`
Update RELEASES.md 2022-02-04 08:41:29 +00:00
			`### 1.0.9`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
			`- Use @azure/ms-rest-js v2.6.0`
			`- Use @azure/storage-blob v12.8.0`
Update `lockfileVersion` in `package-lock.json` in `cache` package (#1022) * update versions * update release notes 2022-03-16 18:25:03 +00:00
			`### 1.0.10`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
bumped up the @action/cache version. 2022-03-24 11:19:52 +00:00			- Update `lockfileVersion` to `v2` in `package-lock.json [#1022](https://github.com/actions/toolkit/pull/1022)

			`### 1.0.11`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
bumped up the @action/cache version. 2022-03-24 11:19:52 +00:00			`- Fix file downloads > 2GB([issue](https://github.com/actions/cache/issues/773))`
Adding support in cache package to check if Artifact Cache service is enabled or not (#1028) * Added support to check if Artifact cache service is enabled or not. * enablingForGHES * added ACTIONS_CACHE_URL in fixtures * Fix CI * CI fix * changed function name * Function rename * Updated release * added test case * Update RELEASES.md * Lint errors * lint * linting * lint * update name to actions service * Update packages/cache/src/internal/cacheUtils.ts Co-authored-by: Brian Cristante <33549821+brcrista@users.noreply.github.com> * review comments * linting * linting * push to start CI * Update RELEASES.md * remove extra spaces * reverting version update * Revert "reverting version update" This reverts commit af84eba61ef8c119458dc0ce1da85b01d61b9d13. * Update RELEASES.md Co-authored-by: Brian Cristante <33549821+brcrista@users.noreply.github.com> 2022-03-25 09:10:02 +00:00
			`### 2.0.0`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Adding support in cache package to check if Artifact Cache service is enabled or not (#1028) * Added support to check if Artifact cache service is enabled or not. * enablingForGHES * added ACTIONS_CACHE_URL in fixtures * Fix CI * CI fix * changed function name * Function rename * Updated release * added test case * Update RELEASES.md * Lint errors * lint * linting * lint * update name to actions service * Update packages/cache/src/internal/cacheUtils.ts Co-authored-by: Brian Cristante <33549821+brcrista@users.noreply.github.com> * review comments * linting * linting * push to start CI * Update RELEASES.md * remove extra spaces * reverting version update * Revert "reverting version update" This reverts commit af84eba61ef8c119458dc0ce1da85b01d61b9d13. * Update RELEASES.md Co-authored-by: Brian Cristante <33549821+brcrista@users.noreply.github.com> 2022-03-25 09:10:02 +00:00			`- Added support to check if Actions cache service feature is available or not [#1028](https://github.com/actions/toolkit/pull/1028)`
Update other packages to use http-client v2 (#1082) We moved `@actions/http-client` to be part of the toolkit in https://github.com/actions/toolkit/pull/1062. We also made some breaking changes to exported types and released v2. The biggest change in terms of lines of code affected was to get rid of the `I-` prefix for interfaces since TypeScript doesn't follow this convention. I bumped the patch version of all packages except for `tool-cache`, where I bumped the major version. The rationale is explained in the release notes for that package. 2022-05-11 21:14:25 +00:00
			`### 2.0.3`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Bump all packages that have @actions/http-client as a dependency (#1088) * bump @actions/artifact * update @actions/cache * Update @actions/core * Update @actions/github * update @actions/tool-cache 2022-05-13 15:12:58 +00:00			- Update to v2.0.0 of `@actions/http-client`

			`### 2.0.4`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Updated RELEASES.md with release information 2022-05-24 06:55:11 +00:00			- Update to v2.0.1 of `@actions/http-client` [#1087](https://github.com/actions/toolkit/pull/1087)

			`### 2.0.5`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Reverted other package-lock.json 2022-06-06 08:03:56 +00:00			`- Fix to avoid saving empty cache when no files are available for caching. ([issue](https://github.com/actions/cache/issues/624))`

			`### 2.0.6`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
new major version release (#1123) 2022-06-24 09:48:30 +00:00			- Fix `Tar failed with error: The process '/usr/bin/tar' failed with exit code 1` issue when temp directory where tar is getting created is actually the subdirectory of the path mentioned by the user for caching. ([issue](https://github.com/actions/cache/issues/689))

			`### 3.0.0`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Fix #809 and #833 in actions/cache. Bump version 2022-08-03 07:00:38 +00:00			`- Updated actions/cache to suppress Actions cache server error and log warning for those error [#1122](https://github.com/actions/toolkit/pull/1122)`

			`### 3.0.1`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Fix #809 and #833 in actions/cache. Bump version 2022-08-03 07:00:38 +00:00			`- Fix [#833](https://github.com/actions/cache/issues/833) - cache doesn't work with github workspace directory.`
Updated version and Releases.md 2022-08-05 07:20:59 +00:00			- Fix [#809](https://github.com/actions/cache/issues/809) `zstd -d: no such file or directory` error on AWS self-hosted runners.

			`### 3.0.2`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Updated release info for v3.0.3 for actions/cache 2022-08-11 07:13:04 +00:00			`- Added 1 hour timeout for the download stuck issue [#810](https://github.com/actions/cache/issues/810).`

			`### 3.0.3`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Bump internal package @actions/cache version to fix #888 and #891 in actions/cache repo 2022-08-13 18:46:24 +00:00			`- Bug fixes for download stuck issue [#810](https://github.com/actions/cache/issues/810).`

			`### 3.0.4`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Merge branch 'main' into pdotl-zstd-win-patch 2022-08-18 11:05:00 +00:00			`- Fix zstd not working for windows on gnu tar in issues [#888](https://github.com/actions/cache/issues/888) and [#891](https://github.com/actions/cache/issues/891).`
Fixed environment variable in the docs. (#1216) 2022-10-18 07:01:00 +00:00			- Allowing users to provide a custom timeout as input for aborting download of a cache segment using an environment variable `SEGMENT_DOWNLOAD_TIMEOUT_MINS`. Default is 60 minutes.
Update RELEASES.md 2022-10-13 09:36:33 +00:00
			`### 3.0.5`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Update RELEASES.md 2022-10-18 17:44:31 +00:00			- Update `@actions/cache` to use `@actions/core@^1.10.0`

			`### 3.0.6`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Update RELEASES.md 2022-10-18 17:44:31 +00:00			- Added `@azure/abort-controller` to dependencies to fix compatibility issue with ESM [#1208](https://github.com/actions/toolkit/issues/1208)
Cache package release for compression change in windows with symlink fix (#1291) * Cache package release for compression change in windows This reverts commit 86fe4abd8e89005bbd880c330af444ae4c7d3b15. * Add env variable to enable windows symlinks * Add cross os opt-in functionality for cache on windows * Fix test * Address review comments * Fix test * Fix tests * Fix tests * Fix tests * Address review comments * Address review comments * Fix tests * Fix tests * Add npm version * Add release details 2023-01-04 06:46:25 +00:00
			`### 3.1.0-beta.1`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Cache package release for compression change in windows with symlink fix (#1291) * Cache package release for compression change in windows This reverts commit 86fe4abd8e89005bbd880c330af444ae4c7d3b15. * Add env variable to enable windows symlinks * Add cross os opt-in functionality for cache on windows * Fix test * Address review comments * Fix test * Fix tests * Fix tests * Fix tests * Address review comments * Address review comments * Fix tests * Fix tests * Add npm version * Add release details 2023-01-04 06:46:25 +00:00			`- Update actions/cache on windows to use gnu tar and zstd by default and fallback to bsdtar and zstd if gnu tar is not available. ([issue](https://github.com/actions/cache/issues/984))`

			`### 3.1.0-beta.2`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Cache package release for compression change in windows with symlink fix (#1291) * Cache package release for compression change in windows This reverts commit 86fe4abd8e89005bbd880c330af444ae4c7d3b15. * Add env variable to enable windows symlinks * Add cross os opt-in functionality for cache on windows * Fix test * Address review comments * Fix test * Fix tests * Fix tests * Fix tests * Address review comments * Address review comments * Fix tests * Fix tests * Add npm version * Add release details 2023-01-04 06:46:25 +00:00			`- Added support for fallback to gzip to restore old caches on windows.`

			`### 3.1.0-beta.3`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Cache package release for compression change in windows with symlink fix (#1291) * Cache package release for compression change in windows This reverts commit 86fe4abd8e89005bbd880c330af444ae4c7d3b15. * Add env variable to enable windows symlinks * Add cross os opt-in functionality for cache on windows * Fix test * Address review comments * Fix test * Fix tests * Fix tests * Fix tests * Address review comments * Address review comments * Fix tests * Fix tests * Add npm version * Add release details 2023-01-04 06:46:25 +00:00			`- Bug Fixes for fallback to gzip to restore old caches on windows and bsdtar if gnutar is not available.`

			`### 3.1.0`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Cache package release for compression change in windows with symlink fix (#1291) * Cache package release for compression change in windows This reverts commit 86fe4abd8e89005bbd880c330af444ae4c7d3b15. * Add env variable to enable windows symlinks * Add cross os opt-in functionality for cache on windows * Fix test * Address review comments * Fix test * Fix tests * Fix tests * Fix tests * Address review comments * Address review comments * Fix tests * Fix tests * Add npm version * Add release details 2023-01-04 06:46:25 +00:00			`- Update actions/cache on windows to use gnu tar and zstd by default`
			`- Update actions/cache on windows to fallback to bsdtar and zstd if gnu tar is not available.`
			`- Added support for fallback to gzip to restore old caches on windows.`

			`### 3.1.1`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Cache package release for compression change in windows with symlink fix (#1291) * Cache package release for compression change in windows This reverts commit 86fe4abd8e89005bbd880c330af444ae4c7d3b15. * Add env variable to enable windows symlinks * Add cross os opt-in functionality for cache on windows * Fix test * Address review comments * Fix test * Fix tests * Fix tests * Fix tests * Address review comments * Address review comments * Fix tests * Fix tests * Add npm version * Add release details 2023-01-04 06:46:25 +00:00			`- Reverted changes in 3.1.0 to fix issue with symlink restoration on windows.`
			`- Added support for verbose logging about cache version during cache miss.`

			`### 3.1.2`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Release patch version update for cache (#1338) 2023-02-09 11:51:19 +00:00			`- Fix issue with symlink restoration on windows.`

			`### 3.1.3`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
Add release info 2023-02-20 18:38:47 +00:00			`- Fix to prevent from setting MYSYS environement variable globally [#1329](https://github.com/actions/toolkit/pull/1329).`

			`### 3.1.4`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
			- Fix zstd not being used due to `zstd --version` output change in zstd 1.5.4 release. See [#1353](https://github.com/actions/toolkit/pull/1353).

Update package version and changelog 2023-02-21 12:56:25 +00:00			`### 3.2.0`
Merge branch 'main' into kotewar/updating-blobstorage-client-to-12.13.0 2023-03-08 19:03:52 +00:00
Update package version and changelog 2023-02-21 12:56:25 +00:00			- Add `lookupOnly` to cache restore `DownloadOptions`.
Merge branch 'main' into kotewar/updating-blobstorage-client-to-12.13.0 2023-03-08 19:03:52 +00:00
			`### 3.2.1`
formatted and updated releases file 2023-03-06 11:56:51 +00:00
			- Updated @azure/storage-blob to `v12.13.0`
Add option for concurrent cache downloads with timeout (#1484) * Add option for concurrent cache downloads with timeout * Add release notes * Fix lint 2023-08-07 17:25:56 +00:00
			`### 3.2.2`

			`- Add new default cache download method to improve performance and reduce hangs [#1484](https://github.com/actions/toolkit/pull/1484)`