From b15dd68d6e8f02b2ad41f99214d73587dafc67f4 Mon Sep 17 00:00:00 2001 From: StephenHodgson Date: Sat, 13 Dec 2025 16:49:22 -0500 Subject: [PATCH] update docs to be clear that compression-level only applies to save --- README.md | 2 +- action.yml | 2 +- save/README.md | 2 +- save/action.yml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3e7f52b..a68ecef 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ If you are using a `self-hosted` Windows runner, `GNU tar` and `zstd` are requir * `key` - An explicit key for a cache entry. See [creating a cache key](#creating-a-cache-key). * `path` - A list of files, directories, and wildcard patterns to cache and restore. See [`@actions/glob`](https://github.com/actions/toolkit/tree/main/packages/glob) for supported patterns. * `restore-keys` - An ordered multiline string listing the prefix-matched keys, that are used for restoring stale cache if no cache hit occurred for key. -* `compression-level` - Compression level to use when creating cache archives. Use `0` for no compression and `9` for maximum compression. Defaults to the compression tool's standard level when unset. +* `compression-level` - Compression level to use when creating cache archives (applies to the save step of the cache action). Use `0` for no compression and `9` for maximum compression. Defaults to the compression tool's standard level when unset. * `enableCrossOsArchive` - An optional boolean when enabled, allows Windows runners to save or restore caches that can be restored or saved respectively on other platforms. Default: `false` * `fail-on-cache-miss` - Fail the workflow if cache entry is not found. Default: `false` * `lookup-only` - If true, only checks if cache entry exists and skips download. Does not change save cache behavior. Default: `false` diff --git a/action.yml b/action.yml index 16b359b..c801019 100644 --- a/action.yml +++ b/action.yml @@ -15,7 +15,7 @@ inputs: description: 'The chunk size used to split up large files during upload, in bytes' required: false compression-level: - description: 'Compression level used when creating cache archives. Set 0 for no compression and 9 for maximum compression. Defaults to the compression tool defaults when unset' + description: 'Compression level used when creating cache archives (save step only). Set 0 for no compression and 9 for maximum compression. Defaults to the compression tool defaults when unset' required: false enableCrossOsArchive: description: 'An optional boolean when enabled, allows windows runners to save or restore caches that can be restored or saved respectively on other platforms' diff --git a/save/README.md b/save/README.md index 3d9913d..1224414 100644 --- a/save/README.md +++ b/save/README.md @@ -9,7 +9,7 @@ The save action saves a cache. It works similarly to the `cache` action except t * `key` - An explicit key for a cache entry. See [creating a cache key](../README.md#creating-a-cache-key). * `path` - A list of files, directories, and wildcard patterns to cache. See [`@actions/glob`](https://github.com/actions/toolkit/tree/main/packages/glob) for supported patterns. * `upload-chunk-size` - The chunk size used to split up large files during upload, in bytes -* `compression-level` - Compression level to use when creating cache archives. Use `0` for no compression and `9` for maximum compression. Defaults to the compression tool's standard level when unset. +* `compression-level` - Compression level to use when creating cache archives (save-only action). Use `0` for no compression and `9` for maximum compression. Defaults to the compression tool's standard level when unset. ### Outputs diff --git a/save/action.yml b/save/action.yml index fccc95e..375b7cb 100644 --- a/save/action.yml +++ b/save/action.yml @@ -12,7 +12,7 @@ inputs: description: 'The chunk size used to split up large files during upload, in bytes' required: false compression-level: - description: 'Compression level used when creating cache archives. Set 0 for no compression and 9 for maximum compression. Defaults to the compression tool defaults when unset' + description: 'Compression level used when creating cache archives (save-only action). Set 0 for no compression and 9 for maximum compression. Defaults to the compression tool defaults when unset' required: false enableCrossOsArchive: description: 'An optional boolean when enabled, allows windows runners to save caches that can be restored on other platforms'