From e08330827dd5663b268018076572bea59a734b60 Mon Sep 17 00:00:00 2001
From: Sankalp Kotewar <98868223+kotewar@users.noreply.github.com>
Date: Fri, 3 Feb 2023 09:53:09 +0530
Subject: [PATCH] Fixed typos and formatting in docs (#1076)

* Removed extra code from readme examples

* Formatted and fixed typos
---
 caching-strategies.md |  4 ++--
 restore/README.md     | 13 +++++++------
 save/README.md        |  3 +--
 3 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/caching-strategies.md b/caching-strategies.md
index a10515a..be2dd34 100644
--- a/caching-strategies.md
+++ b/caching-strategies.md
@@ -200,7 +200,7 @@ If you want to avoid re-computing the cache key again in `save` action, the outp
       path: |
         path/to/dependencies
         some/other/dependencies
-      key: ${{ steps.restore-cache.outputs.key }}
+      key: ${{ steps.restore-cache.outputs.cache-primary-key }}
 ```
 
 ### Re-evaluate cache key while saving cache
@@ -221,7 +221,7 @@ Case 1: Where an user would want to reuse the key as it is
 ```yaml
 uses: actions/cache/save@v3
 with:
-    key: ${{ steps.restore-cache.outputs.key }}
+    key: ${{ steps.restore-cache.outputs.cache-primary-key }}
 ```
 
 Case 2: Where the user would want to re-evaluate the key
diff --git a/restore/README.md b/restore/README.md
index 367e2c6..168835c 100644
--- a/restore/README.md
+++ b/restore/README.md
@@ -13,7 +13,7 @@ The restore action restores a cache. It works similarly to the `cache` action ex
 
 ### Outputs
 
-* `cache-hit` - A boolean value to indicate an exact match was found for the key. 
+* `cache-hit` - A boolean value to indicate an exact match was found for the key.
 * `cache-primary-key` - Cache primary key passed in the input to use in subsequent steps of the workflow.
 * `cache-matched-key` - Key of the cache that was restored, it could either be the primary key on cache-hit or a partial/complete match of one of the restore keys.
 
@@ -21,6 +21,7 @@ The restore action restores a cache. It works similarly to the `cache` action ex
 `cache-hit` will be set to `true` only when cache hit occurs for the exact `key` match. For a partial key match via `restore-keys` or a cache miss, it will be set to `false`.
 
 ### Environment Variables
+
 * `SEGMENT_DOWNLOAD_TIMEOUT_MINS` - Segment download timeout (in minutes, default `60`) to abort download of the segment if not completed in the defined number of minutes. [Read more](https://github.com/actions/cache/blob/main/tips-and-workarounds.md#cache-segment-restore-timeout)
 
 ## Use cases
@@ -58,8 +59,8 @@ Once the cache is restored, unlike `actions/cache`, this action won't run a post
 
 In case of multi-module projects, where the built artifact of one project needs to be reused in subsequent child modules, the need to rebuild the parent module again and again with every build can be eliminated. The `actions/cache` or `actions/cache/save` action can be used to build and save the parent module artifact once, and it can be restored multiple times while building the child modules.
 
-
 #### Step 1 - Build the parent module and save it
+
 ```yaml
 steps:
   - uses: actions/checkout@v3
@@ -75,6 +76,7 @@ steps:
 ```
 
 #### Step 2 - Restore the built artifact from cache using the same key and path
+
 ```yaml
 steps:
   - uses: actions/checkout@v3
@@ -119,15 +121,14 @@ steps:
 
 ## Tips
 
-
-#### Reusing primary key and restored key in the save action
+### Reusing primary key and restored key in the save action
 
 Usually you may want to use the same `key` with both `actions/cache/restore` and `actions/cache/save` actions. To achieve this, use `outputs` from the `restore` action to reuse the same primary key (or the key of the cache that was restored).
 
-#### Using restore action outputs to make save action behave just like the cache action
+### Using restore action outputs to make save action behave just like the cache action
 
 The outputs `cache-primary-key` and `cache-matched-key` can be used to check if the restored cache is same as the given primary key. Alternatively, the `cache-hit` output can also be used to check if the restored was a complete match or a partially restored cache.
 
-#### Ensuring proper restores and save happen across the actions
+### Ensuring proper restores and save happen across the actions
 
 It is very important to use the same `key` and `path` that were used by either `actions/cache` or `actions/cache/save` while saving the cache. Learn more about cache key [naming](https://github.com/actions/cache#creating-a-cache-key) and [versioning](https://github.com/actions/cache#cache-version) here.
diff --git a/save/README.md b/save/README.md
index 0b77e65..8ce56d2 100644
--- a/save/README.md
+++ b/save/README.md
@@ -26,10 +26,9 @@ steps:
   - uses: actions/checkout@v3
 
   - name: Install Dependencies
-    if: steps.cache.outputs.cache-hit != 'true'
     run: /install.sh
 
-  - name: Build common artifacts
+  - name: Build artifacts
     run: /build.sh
 
   - uses: actions/cache/save@v3