@ -87,6 +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.
* `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`
@ -359,7 +360,7 @@ We are taking the following steps to better direct requests related to GitHub Ac
1. We will be directing questions and support requests to our [Community Discussions area](https://github.com/orgs/community/discussions/categories/actions)
2. High Priority bugs can be reported through Community Discussions or you can report these to our support team https://support.github.com/contact/bug-report.
2. High Priority bugs can be reported through Community Discussions or you can report these to our support team <https://support.github.com/contact/bug-report>.
3. Security Issues should be handled as per our [security.md](SECURITY.md).
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'
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'
@ -9,6 +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.
### Outputs
@ -16,7 +17,6 @@ This action has no outputs.
## Use cases
### Only save cache
If you are using separate jobs for generating common artifacts and sharing them across jobs, this action will take care of your cache saving needs.
@ -54,6 +54,7 @@ with:
```
#### Case 1 - Where a user would want to reuse the key as it is
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'
required:false
enableCrossOsArchive:
description:'An optional boolean when enabled, allows windows runners to save caches that can be restored on other platforms'