Fix cache re-evaluation key example in caching strategies docs - #1716
Open
AetherUnbound wants to merge 1 commit into
Open
Fix cache re-evaluation key example in caching strategies docs#1716AetherUnbound wants to merge 1 commit into
AetherUnbound wants to merge 1 commit into
Conversation
Copy link
Copy Markdown
Sorry, something went wrong.
Based on the example provided, the save key here would always be different from the cache restore key. And on top of that, the function call for `hashFiles` looked incorrect on the save action (both in casing and for the files it was hashing). This PR aligns the examples so they'd restore & save for the same purpose.
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the caching strategies documentation to ensure the “re-evaluate cache key” example uses a consistent cache key between restore and save, correcting the previously misleading example.
Changes:
- Fixes the cache save key example to match the restore key prefix/pattern.
- Corrects the hashFiles function casing/usage in the example so the demonstrated key computation is consistent.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sorry, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Based on the example provided, the save key here would always be different from the cache restore key. And on top of that, the function call for hashFiles looked incorrect on the save action (both in casing and for the files it was hashing).
This PR aligns the examples so they'd restore & save for the same purpose.
Motivation and Context
The documentation is a bit misleading here.
Types of changes
Checklist: