Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lima-limon-inc
Copy link

@lima-limon-inc lima-limon-inc commented Dec 11, 2024

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)
  • Documentation (add or update README or docs)

Checklist:

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

@lima-limon-inc lima-limon-inc requested a review from a team as a code owner December 11, 2024 12:28
@PaulRBerg
Copy link

PaulRBerg commented Apr 16, 2025

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

#1566 (comment)

@lima-limon-inc
Copy link
Author

lima-limon-inc commented Apr 16, 2025

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: #1513

@andreasabel
Copy link

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

Copy link

@andreasabel andreasabel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation is unclear about cache-hit's value when the cache misses.
5 participants