From 22f4b2eeaae6ab7f259df0b26cc200d1f292ad4f Mon Sep 17 00:00:00 2001 From: Al Sutton Date: Tue, 21 Dec 2021 13:11:33 +0000 Subject: [PATCH] Update docs --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index f3cea5d2..bb580bd9 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,10 @@ Currently, the following distributions are supported: ### Caching packages dependencies The action has a built-in functionality for caching and restoring dependencies. It uses [actions/cache](https://github.com/actions/cache) under hood for caching dependencies but requires less configuration settings. Supported package managers are gradle and maven. The cache input is optional, and caching is turned off by default. +The option to use the cache in a read-only mode is available via the parameter `cache-is-read-only`, which +defaults to `false`. When set to `true`, and caching is enabled, this allows PR workflows to benefit from +cached build artifacts, but not taint the cache with PR specific changes which may be in a state of flux. + #### Caching gradle dependencies ```yaml steps: