Improve Cache Details documentation #49
Merged
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.
Thank you for a great tool!
This updates the documentation on how the cache works to more closely match the implementation and to explain some of the design decisions.
In addition, I've made a few wording/detail tweaks based on questions I had when first using this action, that had to be answered by source code inspection. (For example: "is the cache key only based off of the repo root
Cargo.toml
/Cargo.lock
or all such files in the repository, including subdirectories?".)