actions/cache
1
0
Fork 0
mirror of https://github.com/actions/cache.git synced 2024-11-23 02:11:27 +01:00
Code Issues Projects Releases Packages Wiki Activity

Added cache hit info in readme

Browse source
This commit is contained in:
Sankalp Kotewar 2022-12-14 10:23:32 +00:00 committed by GitHub
parent 8031e403b4
commit 65057ce6fe
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
restore/README.md
View file

@ -16,8 +16,8 @@ It is very important to use the same `key` and `path` that were used by either `
## Outputs ## Outputs
* `cache-hit` - A boolean value to indicate an exact match was found for the key. * `cache-hit` - A boolean value to indicate an exact match was found for the key.
* `cache-primary-key` - Cache primary key passed in the input to use in subsequent steps of the workflow * `cache-primary-key` - Cache primary key passed in the input to use in subsequent steps of the workflow.
* `cache-restore-key` - Cache key restored * `cache-matched-key` - Key of the cache that was restored, it could either be the primary key on cache-hit or a partial/complete match of one of the restore keys.
> **Note** > **Note**
`cache-hit` will be set to `true` only when cache hit occurs for the exact `key` match. For a partial key match via `restore-keys` or a cache miss, it will be set to `false`. `cache-hit` will be set to `true` only when cache hit occurs for the exact `key` match. For a partial key match via `restore-keys` or a cache miss, it will be set to `false`.
@ -124,3 +124,7 @@ Since this action comes with its own set of pros and cons, we are listing some o
### Reusing primary key and restored key in the save action ### Reusing primary key and restored key in the save action
One of the limitation you might experience is passing the same input in both `actions/cache/restore` and `actions/cache/save` action. To avoid this, you can make use of the `outputs` from the restore action to reuse the same primary key and also the key of the cache that was restored. This way changing any key in the restore action will automatically reflect in the subsequent actions where the same input is being used. One of the limitation you might experience is passing the same input in both `actions/cache/restore` and `actions/cache/save` action. To avoid this, you can make use of the `outputs` from the restore action to reuse the same primary key and also the key of the cache that was restored. This way changing any key in the restore action will automatically reflect in the subsequent actions where the same input is being used.
### Using restore action outputs to make save action behave just like the cache action
The outputs `cache-primary-key` and `cache-matched-key` can be used to check if the restored cache is same as the given primary key. Alternatively, the `cache-hit` output can also be used to check if the restored was a complete match or a partially restored cache.