Please make it clearer that the save and restore paths must match.
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5.6k
- Forks
- 1.6k
- PR merge metrics
- No merged PRs in 30d
Description
Neither the README nor the error messages explicitly mention directory paths needing to stay the same. It's followed in the example and referenced in the cache version section, but it's easy to miss there.
When they're different, the error is simply 'Cache not found for input keys' but doesn't clarify that the failure is due to the (hidden) path/compression logic.
REQUEST:
-
The README's save/restore section should mention that the directories must be the same.
-
Extend the 'Cache not found for input keys' message to 'Cache not found for input keys or version hash:' or add a separate 'Cache entry for key found but did not match cache version hash' error.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the README's save/restore section and cache version section, then locate the code and tests that produce “Cache not found for input keys.” Update the documentation to state that save and restore directories must match, clarify the version-hash failure message, and verify the relevant tests and wording.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, typescript
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100