search

hendrikmuhs / ccache-action

github action to speedup building using ccache
MIT License
122 stars 54 forks source link

Improve docs regarding cache key matching #188

Open dabrahams opened 8 months ago

dabrahams commented 8 months ago

I keep having the experience that the restore step fails even when caches with the right key clearly exist. I don't know how to explain when the key lookup is successful.

dabrahams commented 8 months ago

Some or all of this effect may come down to branch-scoping, which I only just discovered. Since this action's docs (rightly) don't say “go read everything about actions/cache on which it is based,” it might be a good idea to mention this in the README.

hendrikmuhs commented 8 months ago

Are you fine with changing the title to: "Improve docs regarding cache key matching"?

Note that you have to see it from a security perspective as well: You don't want a PR/feature branch to be able to "infect" the main branch cache. LBNL caching itself is just a way to speed up things if possible, there is no guarantee on hitting.

FWIW: Feel free to create a PR with improvements on the README.

dabrahams commented 8 months ago

Feel free to create a PR with improvements on the README.

At the time of my posting, I didn't understand how cacheing works well enough to even take a shot at it. Now I understand what GH does (I think), but not necessarily what this plugin adds to the picture. Until I have that info I wouldn't know what to write.