mirror of
				https://github.com/actions/cache.git
				synced 2025-11-04 05:19:10 +08:00 
			
		
		
		
	docs: Make the "always save prime numbers" example more clear (#1525)
This commit is contained in:
		@@ -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-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.
 | 
					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
 | 
					```yaml
 | 
				
			||||||
name: Always Caching Primes
 | 
					name: Always Caching Prime Numbers
 | 
				
			||||||
 | 
					
 | 
				
			||||||
on: push
 | 
					on: push
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -91,23 +93,23 @@ jobs:
 | 
				
			|||||||
    steps:
 | 
					    steps:
 | 
				
			||||||
    - uses: actions/checkout@v4
 | 
					    - 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
 | 
					      uses: actions/cache/restore@v4
 | 
				
			||||||
      with:
 | 
					      with:
 | 
				
			||||||
        key: ${{ runner.os }}-primes
 | 
					        key: ${{ runner.os }}-prime-numbers
 | 
				
			||||||
        path: |
 | 
					        path: |
 | 
				
			||||||
          path/to/dependencies
 | 
					          path/to/dependencies
 | 
				
			||||||
          some/other/dependencies
 | 
					          some/other/dependencies
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    # Intermediate workflow steps
 | 
					    # 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
 | 
					      uses: actions/cache/save@v4
 | 
				
			||||||
      with:
 | 
					      with:
 | 
				
			||||||
        key: ${{ steps.cache-primes-restore.outputs.cache-primary-key }}
 | 
					        key: ${{ steps.cache-prime-numbers-restore.outputs.cache-primary-key }}
 | 
				
			||||||
        path: |
 | 
					        path: |
 | 
				
			||||||
          path/to/dependencies
 | 
					          path/to/dependencies
 | 
				
			||||||
          some/other/dependencies
 | 
					          some/other/dependencies
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user