Merge 0b16518fffd895fbef333c83f4e76a9f4565bf40 into 36f1e144e1c8edb0a652766b484448563d8baf46

GitHub was spelled incorrectly 3 lines under the Understanding how to choose path section

caching-strategies.md

@@ -102,7 +102,7 @@ The [GitHub Context](https://docs.github.com/en/actions/learn-github-actions/con
 
 While setting paths for caching dependencies it is important to give correct path depending on the hosted runner you are using or whether the action is running in a container job. Assigning different `path` for save and restore will result in cache miss.
 
-Below are GiHub hosted runner specific paths one should take care of when writing a workflow which saves/restores caches across OS.
+Below are GitHub hosted runner specific paths one should take care of when writing a workflow which saves/restores caches across OS.
 
 #### Ubuntu Paths
 

examples.md

@@ -25,6 +25,7 @@
 - [Node - Yarn](#node---yarn)
 - [Node - Yarn 2](#node---yarn-2)
 - [OCaml/Reason - esy](#ocamlreason---esy)
+- [OCaml/Reason - opam](#ocamlreason---opam)
 - [PHP - Composer](#php---composer)
 - [Python - pip](#python---pip)
   - [Simple example](#simple-example)
@@ -437,6 +438,30 @@ Esy allows you to export built dependencies and import pre-built dependencies.
       if: steps.restore-cache.outputs.cache-hit != 'true'
 ```
 
+## OCaml/Reason - opam
+
+This example requires you to have `opam.locked` file which you can generate with `opam lock .`.
+
+It's worth noting that even if lock file was change, it might be optimal to restore previous cache, so `hashFiles` in the key and if statement in "Save opam cache" step are optional.
+```yaml
+    - name: Restore opam cache
+      id: restore-cache
+      uses: actions/cache/restore@v4
+      with:
+        path: _opam
+        key: ${{ runner.os }}-opam-${{ hashFiles('opam.locked') }}
+
+    - name: Install dependencies
+      run: opam install . --locked --deps-only -y
+
+    - name: Save opam cache
+      if: steps.restore-cache.outputs.cache-hit != 'true'
+      uses: actions/cache/save@v4
+      with:
+        path: _opam
+        key: ${{ steps.restore-cache.outputs.cache-primary-key }}
+```
+
 ## PHP - Composer
 
 ```yaml

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