Skip to content
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

Add "cache name" to @action/cache APIs, so log messages could be tailored to the cache in question #538

Open
vlsi opened this issue Aug 3, 2020 · 0 comments
Labels
cache enhancement New feature or request

Comments

@vlsi
Copy link

vlsi commented Aug 3, 2020

Describe the enhancement

Current saveCache and restoreCache work, and they are useful for creating customized caches.
It would be great if the methods could take cacheName as an extra option.

Then the logging inside @actions/cache can include caheName, so the logs are human-friendly.

Code Snippet

saveCache(["~/.m2/repository"], "main-" + hashFiles("**/pom.xml"), { cacheName: "Maven local repository" })
restoreCache(["~/.m2/repository"], "main-" + hashFiles("**/pom.xml"), ["main-"], { cacheName: "./m2/repository" })

Additional information

Current logging might look like the following.
It is hard to tell which cache was not found, and it is hard to tell which cache is 30MiB, and which is 5MiB.

Cache was not found for dependencies-maven-macOS-master-e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855, restore keys: dependencies-maven-macOS-master
Received 31360354 of 31360354 (100.0%), 43.0 MBs/sec
Cache Size: ~30 MB (31360354 B)
/usr/bin/tar --use-compress-program zstd -d -xf /Users/runner/work/_temp/feef5a0b-b9e2-4376-b2cb-4a9da63ef6ec/cache.tzst -P -C /Users/runner/work/calcite/calcite
Received 5672258 of 5672258 (100.0%), 8.9 MBs/sec
Cache Size: ~5 MB (5672258 B)
Received 41943040 of 361858910 (11.6%), 39.1 MBs/sec
/usr/bin/tar --use-compress-program zstd -d -xf /Users/runner/work/_temp/8b10504b-9c4c-4d2c-9bf5-8d672093ed38/cache.tzst -P -C /Users/runner/work/calcite/calcite

If cacheName is added, then each message could be prefixed with a cache name.

WDYT?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cache enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants