From 53aa38c736a561b9c17b62df3fe885a17b78ee6d Mon Sep 17 00:00:00 2001 From: janco-absa Date: Mon, 6 Jan 2025 18:55:00 +0200 Subject: [PATCH 1/2] Correct GitHub Spelling in caching-strategies.md (#1526) GitHub was spelled incorrectly 3 lines under the Understanding how to choose path section --- caching-strategies.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/caching-strategies.md b/caching-strategies.md index 86ae37c..a51d5f3 100644 --- a/caching-strategies.md +++ b/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 From 36f1e144e1c8edb0a652766b484448563d8baf46 Mon Sep 17 00:00:00 2001 From: Tobbe Lundberg Date: Fri, 10 Jan 2025 06:36:56 +0700 Subject: [PATCH 2/2] docs: Make the "always save prime numbers" example more clear (#1525) --- save/README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/save/README.md b/save/README.md index e986626..dc45c38 100644 --- a/save/README.md +++ b/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