From 5c5e91f040ecf177de8eea4a62a9b9e5ce30ed69 Mon Sep 17 00:00:00 2001 From: Sankalp Kotewar <98868223+kotewar@users.noreply.github.com> Date: Thu, 18 Aug 2022 06:46:57 +0000 Subject: [PATCH] Updated Segment readme and version --- packages/cache/README.md | 4 ++-- packages/cache/RELEASES.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/cache/README.md b/packages/cache/README.md index 58f959ec..b8e50401 100644 --- a/packages/cache/README.md +++ b/packages/cache/README.md @@ -44,6 +44,6 @@ const cacheKey = await cache.restoreCache(paths, key, restoreKeys) ##### Cache segment restore timeout -Starting `v3.0.5` of `actions/toolkit`, in case any issue occurs while downloading the cache, the download will be aborted by default within 1 hour if any `segment` doesn't download completely. A `segment` is limited to size of `1GB` for a `32-bit` runner and `2GB` for a `64-bit` runner. So for any cache that exceeds the size of one segment, multiple segments will be downloaded in sequence to complete the download. +Version `v3.0.4` of cache package introduces a segment download timeout. A cache gets downloaded in multiple segments of fixed sizes (`1GB` for a `32-bit` runner and `2GB` for a `64-bit` runner). Sometimes, a segment download gets stuck which causes the workflow job to be stuck forever and fail. The segment download timeout will allow the segment download to get aborted and hence allow the job to proceed with a cache miss. -To customise the `segment` download timeout, an environment variable `SEGMENT_DOWNLOAD_TIMEOUT_MINS` needs to be set with the timeout minutes. This way the download wouldn't get stuck forever and proceed to next step in the workflow without any problem. +Default value of this timeout is 1 hour and can be customized by specifying an [environment variable](https://docs.github.com/en/actions/learn-github-actions/environment-variables) named `SEGMENT_DOWNLOAD_TIMEOUT_MINS`. \ No newline at end of file diff --git a/packages/cache/RELEASES.md b/packages/cache/RELEASES.md index 4f177f4c..b9ff58f7 100644 --- a/packages/cache/RELEASES.md +++ b/packages/cache/RELEASES.md @@ -82,5 +82,5 @@ ### 3.0.3 - Bug fixes for download stuck issue [#810](https://github.com/actions/cache/issues/810). -### 3.0.5 +### 3.0.4 - Allowing users to provide a custom timeout as input for aborting download of a cache segment using an environment variable `SEGMENT_DOWNLOAD_TIMEOUT_MIN`. Default is 1 hour. \ No newline at end of file