mirror of
https://github.com/actions/cache.git
synced 2024-11-24 18:51:26 +01:00
88 lines
2.9 KiB
Markdown
88 lines
2.9 KiB
Markdown
# Save action
|
|
|
|
The save action saves a cache. It works similarly to the `cache` action except that it doesn't first do a restore. This action provides granular ability to save a cache without having to restore it, or to do a save at any stage of the workflow job -- not only in post phase.
|
|
|
|
## Documentation
|
|
|
|
### Inputs
|
|
|
|
* `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
|
|
|
|
### Outputs
|
|
|
|
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.
|
|
|
|
```yaml
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
|
|
- name: Install Dependencies
|
|
run: /install.sh
|
|
|
|
- name: Build artifacts
|
|
run: /build.sh
|
|
|
|
- uses: actions/cache/save@v3
|
|
id: cache
|
|
with:
|
|
path: path/to/dependencies
|
|
key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
|
|
```
|
|
|
|
### Re-evaluate cache key while saving
|
|
|
|
With this save action, the key can now be re-evaluated while executing the action. This helps in cases where lockfiles are generated during the build.
|
|
|
|
Let's say we have a restore step that computes a key at runtime.
|
|
|
|
#### Restore a cache
|
|
|
|
```yaml
|
|
uses: actions/cache/restore@v3
|
|
id: restore-cache
|
|
with:
|
|
key: cache-${{ hashFiles('**/lockfiles') }}
|
|
```
|
|
|
|
#### Case 1 - Where a user would want to reuse the key as it is
|
|
```yaml
|
|
uses: actions/cache/save@v3
|
|
with:
|
|
key: ${{ steps.restore-cache.outputs.cache-primary-key }}
|
|
```
|
|
|
|
#### Case 2 - Where the user would want to re-evaluate the key
|
|
|
|
```yaml
|
|
uses: actions/cache/save@v3
|
|
with:
|
|
key: npm-cache-${{hashfiles(package-lock.json)}}
|
|
```
|
|
|
|
### Always save cache
|
|
|
|
There are instances where some flaky test cases would fail the entire workflow and users would get frustrated because the builds would run for hours and the cache couldn't be saved as the workflow failed in between. For such use-cases, users now have the ability to use the `actions/cache/save` action to save the cache by using an `if: always()` condition. This way the cache will always be saved if generated, or a warning will be generated that nothing is found on the cache path. Users can also use the `if` condition to only execute the `actions/cache/save` action depending on the output of previous steps. This way they get more control of when to save the cache.
|
|
|
|
```yaml
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
.
|
|
. // restore if need be
|
|
.
|
|
- name: Build
|
|
run: /build.sh
|
|
- uses: actions/cache/save@v3
|
|
if: always() // or any other condition to invoke the save action
|
|
with:
|
|
path: path/to/dependencies
|
|
key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
|
|
```
|