mirror of
				https://github.com/actions/cache.git
				synced 2025-11-04 15:48:39 +08:00 
			
		
		
		
	Update README.md
This commit is contained in:
		
							parent
							
								
									4fe9c4bd54
								
							
						
					
					
						commit
						5294b3f306
					
				| 
						 | 
					@ -34,17 +34,18 @@ If you are using this inside a container, a POSIX-compliant `tar` needs to be in
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* `path` - A list of files, directories, and wildcard patterns to cache and restore. See [`@actions/glob`](https://github.com/actions/toolkit/tree/main/packages/glob) for supported patterns.
 | 
					* `path` - A list of files, directories, and wildcard patterns to cache and restore. See [`@actions/glob`](https://github.com/actions/toolkit/tree/main/packages/glob) for supported patterns.
 | 
				
			||||||
* `key` - An explicit key for restoring and saving the cache
 | 
					* `key` - An explicit key for restoring and saving the cache
 | 
				
			||||||
* `restore-keys` - An ordered list of prefix-matched keys to use for restoring stale cache if no cache hit occurred for key. Note
 | 
					* `restore-keys` - An ordered list of prefix-matched keys to use for restoring stale cache if no cache hit occurred for key.
 | 
				
			||||||
`cache-hit` returns false in this case.
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
#### Environment Variables
 | 
					#### 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](#cache-segment-restore-timeout)
 | 
					* `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](#cache-segment-restore-timeout)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Outputs
 | 
					### 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. 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
> See [Skipping steps based on cache-hit](#Skipping-steps-based-on-cache-hit) for info on using this output
 | 
					> Note: `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`. It is recommended to install the missing/updated dependencies in case of a partial key match when the key is dependent on the `hash` of the package file.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					See [Skipping steps based on cache-hit](#skipping-steps-based-on-cache-hit) for info on using this output
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Cache scopes
 | 
					### Cache scopes
 | 
				
			||||||
The cache is scoped to the key and branch. The default branch cache is available to other branches.
 | 
					The cache is scoped to the key and branch. The default branch cache is available to other branches.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in New Issue
	
	Block a user