diff --git a/README.md b/README.md index 07f12e8..dff781e 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,9 @@ Create a workflow `.yml` file in your repositories `.github/workflows` directory * `key` - An explicit key for restoring and saving the cache * `restore-keys` - An ordered list of keys to use for restoring the cache if no cache hit occurred for key +### Environment Variables + * `CACHE_SKIP_SAVE` - [optional] When set to `true`, any modifications made to the restored cache will not be persisted back at the end of the step. This environment variable can be set at any time using `echo "CACHE_SKIP_SAVE=true" >> $GITHUB_ENV` + ### Outputs * `cache-hit` - A boolean value to indicate an exact match was found for the key