cache icon indicating copy to clipboard operation
cache copied to clipboard

Explicitly document how to have cache always updated.

Open krpatter-intc opened this issue 2 years ago • 2 comments

Add to Readme the best-known-method for making sure you save your cache information

It would be worth spelling out in the README the details mentioned here:

https://github.com/actions/cache/issues/342#issuecomment-673371329

for how to support the ability to always work with and then update a cache

krpatter-intc avatar Jun 30 '22 19:06 krpatter-intc

To add to this, the docs say:

  1. If the job completes successfully, the action automatically creates a new cache with the contents of the path directory.

https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#example-using-the-cache-action

It does not specify that the cache is only stored on a cache miss. Confirmed in the code here: https://github.com/actions/cache/blob/main/src/save.ts#L36-L41

If the code is stay as-is, the main docs need to be updated to clarify this.

Jamie- avatar Aug 19 '22 10:08 Jamie-

Agree, we can probably update both README as well as the docs.

bishal-pdMSFT avatar Aug 19 '22 10:08 bishal-pdMSFT

This issue is stale because it has been open for 200 days with no activity. Leave a comment to avoid closing this issue in 5 days.

github-actions[bot] avatar Oct 18 '23 08:10 github-actions[bot]

This issue was closed because it has been inactive for 5 days since being marked as stale.

github-actions[bot] avatar Oct 23 '23 08:10 github-actions[bot]