Merge 0e22a2cc9865cad32793aa08c71c1af7096b3386 into 36f1e144e1c8edb0a652766b484448563d8baf46

examples.md

@@ -22,6 +22,7 @@
 - [Java - Maven](#java---maven)
 - [Node - npm](#node---npm)
 - [Node - Lerna](#node---lerna)
+- [Node - pnpm](#node---pnpm)
 - [Node - Yarn](#node---yarn)
 - [Node - Yarn 2](#node---yarn-2)
 - [OCaml/Reason - esy](#ocamlreason---esy)
@@ -374,6 +375,22 @@ After [deprecation](https://github.blog/changelog/2022-10-11-github-actions-depr
     key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
 ```
 
+## Node - pnpm
+
+```yaml
+- name: Get pnpm store directory
+  shell: bash
+  run: |
+    echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+- uses: actions/cache@v4
+  name: Setup pnpm cache
+  with:
+    path: ${{ env.STORE_PATH }}
+    key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+    restore-keys: |
+      ${{ runner.os }}-pnpm-store-
+```
+
 ## Node - Yarn
 The yarn cache directory will depend on your operating system and version of `yarn`. See https://yarnpkg.com/lang/en/docs/cli/cache/ for more info.
 

save/README.md

@@ -79,8 +79,10 @@ To avoid saving a cache that already exists, the `cache-hit` output from a resto
 The `cache-primary-key` output from the restore step should also be used to ensure
 the cache key does not change during the build if it's calculated based on file contents.
 
+Here's an example where we imagine we're calculating a lot of prime numbers and want to cache them:
+
 ```yaml
-name: Always Caching Primes
+name: Always Caching Prime Numbers
 
 on: push
 
@@ -91,23 +93,23 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
-    - name: Restore cached Primes
+    - name: Restore cached Prime Numbers
-      id: cache-primes-restore
+      id: cache-prime-numbers-restore
       uses: actions/cache/restore@v4
       with:
-        key: ${{ runner.os }}-primes
+        key: ${{ runner.os }}-prime-numbers
         path: |
           path/to/dependencies
           some/other/dependencies
 
     # Intermediate workflow steps
 
-    - name: Always Save Primes
+    - name: Always Save Prime Numbers
-      id: cache-primes-save
+      id: cache-prime-numbers-save
-      if: always() && steps.cache-primes-restore.outputs.cache-hit != 'true'
+      if: always() && steps.cache-prime-numbers-restore.outputs.cache-hit != 'true'
       uses: actions/cache/save@v4
       with:
-        key: ${{ steps.cache-primes-restore.outputs.cache-primary-key }}
+        key: ${{ steps.cache-prime-numbers-restore.outputs.cache-primary-key }}
         path: |
           path/to/dependencies
           some/other/dependencies