From 006762a55aaa539e0b59cd36b1861ad0a4bf497d Mon Sep 17 00:00:00 2001 From: Dany Sam <danisam17@gmail.com> Date: Fri, 11 Apr 2025 14:08:49 +0530 Subject: [PATCH] Update RELEASES.md for v1.0.0 release --- RELEASES.md | 191 ++++++---------------------------------------------- 1 file changed, 20 insertions(+), 171 deletions(-) diff --git a/RELEASES.md b/RELEASES.md index b859f15..d5bc529 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -1,174 +1,23 @@ # Releases -### 4.2.3 +## v1.0.0 (2025-04-11) + +### Added +- Google Cloud Storage (GCS) support as a cache backend with automatic fallback to GitHub's built-in cache +- `gcs-bucket` parameter to specify the GCS bucket for caching +- `gcs-path-prefix` parameter to specify a custom prefix within the GCS bucket (defaults to "github-cache") +- Comprehensive documentation for GCS integration in README and examples +- New examples demonstrating GCS usage in different scenarios +- Added GCS-specific sections to tips-and-workarounds.md + +### Benefits +- Store caches beyond GitHub's 10GB repository limit +- Share caches across multiple repositories +- Custom retention policies through GCS lifecycle management +- Cross-branch cache sharing capabilities + +### Compatibility +- Maintains full compatibility with the original GitHub cache action API +- Based on actions/cache@v4 with all existing features preserved +- Compatible with both service account keys and Workload Identity Federation -- Bump `@actions/cache` to v4.0.3 (obfuscates SAS token in debug logs for cache entries) - -### 4.2.2 - -- Bump `@actions/cache` to v4.0.2 - -### 4.2.1 - -- Bump `@actions/cache` to v4.0.1 - -### 4.2.0 - -TLDR; The cache backend service has been rewritten from the ground up for improved performance and reliability. [actions/cache](https://github.com/actions/cache) now integrates with the new cache service (v2) APIs. - -The new service will gradually roll out as of **February 1st, 2025**. The legacy service will also be sunset on the same date. Changes in these release are **fully backward compatible**. - -**We are deprecating some versions of this action**. We recommend upgrading to version `v4` or `v3` as soon as possible before **February 1st, 2025.** (Upgrade instructions below). - -If you are using pinned SHAs, please use the SHAs of versions `v4.2.0` or `v3.4.0` - -If you do not upgrade, all workflow runs using any of the deprecated [actions/cache](https://github.com/actions/cache) will fail. - -Upgrading to the recommended versions will not break your workflows. - -### 4.1.2 - -- Add GitHub Enterprise Cloud instances hostname filters to inform API endpoint choices - [#1474](https://github.com/actions/cache/pull/1474) -- Security fix: Bump braces from 3.0.2 to 3.0.3 - [#1475](https://github.com/actions/cache/pull/1475) - -### 4.1.1 - -- Restore original behavior of `cache-hit` output - [#1467](https://github.com/actions/cache/pull/1467) - -### 4.1.0 - -- Ensure `cache-hit` output is set when a cache is missed - [#1404](https://github.com/actions/cache/pull/1404) -- Deprecate `save-always` input - [#1452](https://github.com/actions/cache/pull/1452) - -### 4.0.2 - -- Fixed restore `fail-on-cache-miss` not working. - -### 4.0.1 - -- Updated `isGhes` check - -### 4.0.0 - -- Updated minimum runner version support from node 12 -> node 20 - -### 3.4.0 - -- Integrated with the new cache service (v2) APIs - -### 3.3.3 - -- Updates @actions/cache to v3.2.3 to fix accidental mutated path arguments to `getCacheVersion` [actions/toolkit#1378](https://github.com/actions/toolkit/pull/1378) -- Additional audit fixes of npm package(s) - -### 3.3.2 - -- Fixes bug with Azure SDK causing blob downloads to get stuck. - -### 3.3.1 - -- Reduced segment size to 128MB and segment timeout to 10 minutes to fail fast in case the cache download is stuck. - -### 3.3.0 - -- Added option to lookup cache without downloading it. - -### 3.2.6 - -- Fix zstd not being used after zstd version upgrade to 1.5.4 on hosted runners. - -### 3.2.5 - -- Added fix to prevent from setting MYSYS environment variable globally. - -### 3.2.4 - -- Added option to fail job on cache miss. - -### 3.2.3 - -- Support cross os caching on Windows as an opt-in feature. -- Fix issue with symlink restoration on Windows for cross-os caches. - -### 3.2.2 - -- Reverted the changes made in 3.2.1 to use gnu tar and zstd by default on windows. - -### 3.2.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)) -- Added support for fallback to gzip to restore old caches on windows. -- Added logs for cache version in case of a cache miss. - -### 3.2.0 - -- Released the two new actions - [restore](restore/action.yml) and [save](save/action.yml) for granular control on cache - -### 3.2.0-beta.1 - -- Added two new actions - [restore](restore/action.yml) and [save](save/action.yml) for granular control on cache. - -### 3.1.0-beta.3 - -- Bug fixes for bsdtar fallback if gnutar not available and gzip fallback if cache saved using old cache action on windows. - -### 3.1.0-beta.2 - -- Added support for fallback to gzip to restore old caches on windows. - -### 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.0.11 - -- Update toolkit version to 3.0.5 to include `@actions/core@^1.10.0` -- Update `@actions/cache` to use updated `saveState` and `setOutput` functions from `@actions/core@^1.10.0` - -### 3.0.10 - -- Fix a bug with sorting inputs. -- Update definition for restore-keys in README.md - -### 3.0.9 - -- Enhanced the warning message for cache unavailablity in case of GHES. - -### 3.0.8 - -- 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.7 - -- Fixed [#810](https://github.com/actions/cache/issues/810) - download stuck issue. A new timeout is introduced in the download process to abort the download if it gets stuck and doesn't finish within an hour. - -### 3.0.6 - -- Fixed [#809](https://github.com/actions/cache/issues/809) - zstd -d: no such file or directory error -- Fixed [#833](https://github.com/actions/cache/issues/833) - cache doesn't work with github workspace directory - -### 3.0.5 - -- Removed error handling by consuming actions/cache 3.0 toolkit, Now cache server error handling will be done by toolkit. ([PR](https://github.com/actions/cache/pull/834)) - -### 3.0.4 - -- Fixed tar creation error while trying to create tar with path as `~/` home folder on `ubuntu-latest`. ([issue](https://github.com/actions/cache/issues/689)) - -### 3.0.3 - -- Fixed avoiding empty cache save when no files are available for caching. ([issue](https://github.com/actions/cache/issues/624)) - -### 3.0.2 - -- Added support for dynamic cache size cap on GHES. - -### 3.0.1 - -- Added support for caching from GHES 3.5. -- Fixed download issue for files > 2GB during restore. - -### 3.0.0 - -- Updated minimum runner version support from node 12 -> node 16