Set output cache-hit to indicate if cache was hit (#275)

actions · Apr 7, 2022 · d2e3f41 · d2e3f41
1 parent 0aa6f2a
commit d2e3f41
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -70,6 +70,8 @@ The action has a built-in functionality for caching and restoring dependencies.
 - gradle: `**/*.gradle*`, `**/gradle-wrapper.properties`
 - maven: `**/pom.xml`
 
+The workflow output `cache-hit` is set to indicate if an exact match was found for the key [as actions/cache does](https://github.com/actions/cache/tree/main#outputs).
+
 The cache input is optional, and caching is turned off by default.
 
 #### Caching gradle dependencies

diff --git a/dist/cleanup/index.js b/dist/cleanup/index.js
@@ -61925,9 +61925,11 @@ function restore(id) {
         ]);
         if (matchedKey) {
             core.saveState(CACHE_MATCHED_KEY, matchedKey);
+            core.setOutput('cache-hit', matchedKey === primaryKey);
             core.info(`Cache restored from key: ${matchedKey}`);
         }
         else {
+            core.setOutput('cache-hit', false);
             core.info(`${packageManager.id} cache is not found`);
         }
     });

diff --git a/dist/setup/index.js b/dist/setup/index.js
@@ -18662,9 +18662,11 @@ function restore(id) {
         ]);
         if (matchedKey) {
             core.saveState(CACHE_MATCHED_KEY, matchedKey);
+            core.setOutput('cache-hit', matchedKey === primaryKey);
             core.info(`Cache restored from key: ${matchedKey}`);
         }
         else {
+            core.setOutput('cache-hit', false);
             core.info(`${packageManager.id} cache is not found`);
         }
     });

diff --git a/src/cache.ts b/src/cache.ts
@@ -77,8 +77,10 @@ export async function restore(id: string) {
   ]);
   if (matchedKey) {
     core.saveState(CACHE_MATCHED_KEY, matchedKey);
+    core.setOutput('cache-hit', matchedKey === primaryKey);
     core.info(`Cache restored from key: ${matchedKey}`);
   } else {
+    core.setOutput('cache-hit', false);
     core.info(`${packageManager.id} cache is not found`);
   }
 }