Merge b045ea1d9e into 36f1e144e1

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

README.md

@@ -181,6 +181,7 @@ See [Examples](examples.md) for a list of `actions/cache` implementations for us
 * [Clojure - Lein Deps](./examples.md#clojure---lein-deps)
 * [D - DUB](./examples.md#d---dub)
 * [Deno](./examples.md#deno)
+* [Docker](./examples.md#docker)
 * [Elixir - Mix](./examples.md#elixir---mix)
 * [Go - Modules](./examples.md#go---modules)
 * [Haskell - Cabal](./examples.md#haskell---cabal)

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

@@ -10,6 +10,7 @@
   - [Linux](#linux)
   - [macOS](#macos)
   - [Windows](#windows-1)
+- [Docker](#docker)
 - [Elixir - Mix](#elixir---mix)
 - [Erlang - Rebar3](#erlang--rebar3)
 - [Go - Modules](#go---modules)
@@ -176,6 +177,40 @@ steps:
     key: ${{ runner.os }}-deno-${{ hashFiles('**/deps.ts') }}
 ```
 
+## Docker
+
+```yaml
+- name: Cache Docker layers
+  uses: actions/cache@v3
+  with:
+    path: /tmp/.buildx-cache
+    key: my-project-${{ matrix.arch }}-buildx-${{ hashFiles('my-directory/Dockerfile') }}
+    restore-keys: |
+      my-project-${{ matrix.arch }}-buildx-
+- name: Set up QEMU
+  uses: docker/setup-qemu-action@v3
+- name: Set up Docker Buildx
+  uses: docker/setup-buildx-action@v3
+- name: Build and Test
+  uses: docker/build-push-action@v3
+  with:
+    push: false
+    context: .
+    platforms: ${{ matrix.arch }}
+    file: my-directory/Dockerfile
+    tags: my-username/my-image:latest
+    cache-from: type=local,src=/tmp/.buildx-cache
+    cache-to: type=local,dest=/tmp/.buildx-cache-new,mode=max
+-
+  # Temporary workaround
+  # https://github.com/docker/build-push-action/issues/252
+  # https://github.com/moby/buildkit/issues/1896
+  name: Move cache
+  run: |
+    rm -rf /tmp/.buildx-cache
+    mv /tmp/.buildx-cache-new /tmp/.buildx-cache
+```
+
 ## Elixir - Mix
 
 ```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
-      id: cache-primes-restore
+    - name: Restore cached Prime Numbers
+      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
-      id: cache-primes-save
-      if: always() && steps.cache-primes-restore.outputs.cache-hit != 'true'
+    - name: Always Save Prime Numbers
+      id: cache-prime-numbers-save
+      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