cache icon indicating copy to clipboard operation
cache copied to clipboard

Clarify that the empty string is returned if no cache is restored.

Open lima-limon-inc opened this issue 1 year ago • 3 comments

Closes: #1513

Description

Update documentation, so that it reflects the actual behavior of cache-hit.

Motivation and Context

The documentation describes a behavior that does not reflect the actual implementation. This caused quite a headache when trying to debug this action.

How Has This Been Tested?

I updated my .yml so that they follow the logic in this PR and they worked correctly.

Types of changes

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)
  • [X] Documentation (add or update README or docs)

Checklist:

  • [X] My code follows the code style of this project.
  • [X] My change requires a change to the documentation.
  • [X] I have updated the documentation accordingly.
  • [X] I have read the CONTRIBUTING document.
  • [ ] I have added tests to cover my changes.
  • [X] All new and existing tests passed.

lima-limon-inc avatar Dec 11 '24 12:12 lima-limon-inc

Hey @Dinara255 @TheGiraffe3, could you please merge this PR?

https://github.com/actions/cache/issues/1566#issuecomment-2809485815

PaulRBerg avatar Apr 16 '25 12:04 PaulRBerg

Hey @Dinara255 @TheGiraffe3, could you please merge this PR?

#1566 (comment)

Hi @PaulRBerg, thanks for your comment! If I'm not mistaken, neither @Dinara255 nor @TheGiraffe3 are maintainers of this repo (do correct me if I'm wrong).

Maybe we should ping @salmanmkc or @robherley, who have recent contributions to the project.

Btw, a more thorough explanation, with code snippets, can be found on the original issue: https://github.com/actions/cache/issues/1513

lima-limon-inc avatar Apr 16 '25 14:04 lima-limon-inc

See also the fate of my related PR on this issue:

  • https://github.com/actions/cache/pull/1263

andreasabel avatar May 30 '25 21:05 andreasabel