dist

Make it more obvious that the cache call does double duty

.github/auto_assign.yml

@@ -6,7 +6,7 @@ addAssignees: false
 
 # A list of reviewers to be added to pull requests (GitHub user name)
 reviewers:
-  - phantsure
+  - kotewar
   - aparna-ravindra
   - tiwarishub
   - vsvipul

.github/workflows/auto-assign-issues.yml

@@ -11,5 +11,5 @@ jobs:
             - name: 'Auto-assign issue'
               uses: pozil/auto-assign-issue@v1.4.0
               with:
-                  assignees: phantsure,tiwarishub,aparna-ravindra,vsvipul,bishal-pdmsft
+                  assignees: kotewar,tiwarishub,aparna-ravindra,vsvipul,bishal-pdmsft
                   numOfAssignee: 1

README.md

@@ -72,6 +72,8 @@ jobs:
       run: /primes.sh -d prime-numbers
 ```
 
+> Note: You must use the `cache` action in your workflow before you need to use the files that might be restored from the cache. If the provided `key` doesn't match an existing cache, a new cache is automatically created if the job completes successfully.
+
 ## Implementation Examples
 
 Every programming language and framework has its own way of caching.

dist/save/index.js

@@ -46795,10 +46795,9 @@ function run() {
             const cacheId = yield cache.saveCache(cachePaths, primaryKey, {
                 uploadChunkSize: utils.getInputAsInt(constants_1.Inputs.UploadChunkSize)
             });
-            if (cacheId == -1) {
-                return;
+            if (cacheId != -1) {
+                core.info(`Cache saved with key: ${primaryKey}`);
             }
-            core.info(`Cache saved with key: ${primaryKey}`);
         }
         catch (error) {
             utils.logWarning(error.message);

examples.md

@@ -223,6 +223,8 @@ We cache the elements of the Cabal store separately, as the entirety of `~/.caba
 
 ## Haskell - Stack
 
+### Linux or macOS
+
 ```yaml
 - uses: actions/cache@v3
   name: Cache ~/.stack
@@ -240,6 +242,27 @@ We cache the elements of the Cabal store separately, as the entirety of `~/.caba
       ${{ runner.os }}-stack-work-
 ```
 
+### Windows
+
+```yaml
+- uses: actions/cache@v3
+  name: Cache %APPDATA%\stack %LOCALAPPDATA%\Programs\stack
+  with:
+    path: |
+      ~\AppData\Roaming\stack
+      ~\AppData\Local\Programs\stack    
+    key: ${{ runner.os }}-stack-global-${{ hashFiles('stack.yaml') }}-${{ hashFiles('package.yaml') }}
+    restore-keys: |
+      ${{ runner.os }}-stack-global-
+- uses: actions/cache@v3
+  name: Cache .stack-work
+  with:
+    path: .stack-work
+    key: ${{ runner.os }}-stack-work-${{ hashFiles('stack.yaml') }}-${{ hashFiles('package.yaml') }}-${{ hashFiles('**/*.hs') }}
+    restore-keys: |
+      ${{ runner.os }}-stack-work-
+```
+
 ## Java - Gradle
 
 >Note: Ensure no Gradle daemons are running anymore when your workflow completes. Creating the cache package might fail due to locks being held by Gradle. Refer to the [Gradle Daemon documentation](https://docs.gradle.org/current/userguide/gradle_daemon.html) on how to disable or stop the Gradle Daemons.

src/save.ts

@@ -47,11 +47,10 @@ async function run(): Promise<void> {
         const cacheId = await cache.saveCache(cachePaths, primaryKey, {
             uploadChunkSize: utils.getInputAsInt(Inputs.UploadChunkSize)
         });
-        if (cacheId == -1) {
-            return;
-        }
 
-        core.info(`Cache saved with key: ${primaryKey}`);
+        if (cacheId != -1) {
+            core.info(`Cache saved with key: ${primaryKey}`);
+        }
     } catch (error: unknown) {
         utils.logWarning((error as Error).message);
     }