Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README with clearer info about cache-hit and its value #961

Merged
merged 3 commits into from
Oct 26, 2022
Merged

Update README with clearer info about cache-hit and its value #961

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5294b3f
Update README.md
kotewar Oct 18, 2022
083fb30
Merge branch 'main' into kotewar/doc-update
kotewar Oct 26, 2022
14f2d18
Moved recommendation to skipping steps section
kotewar Oct 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Moved recommendation to skipping steps section
  • Loading branch information
@kotewar
kotewar authored Oct 26, 2022
commit 14f2d18ea2a8de1085ccf3aedfeb86ef1f4b7bdd
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ If you are using this inside a container, a POSIX-compliant `tar` needs to be in

* `cache-hit` - A boolean value to indicate an exact match was found for the key.

> 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.
> 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`.

See [Skipping steps based on cache-hit](#skipping-steps-based-on-cache-hit) for info on using this output

Expand Down Expand Up @@ -153,7 +153,7 @@ A repository can have up to 10GB of caches. Once the 10GB limit is reached, olde

## Skipping steps based on cache-hit

Using the `cache-hit` output, subsequent steps (such as install or build) can be skipped when a cache hit occurs on the key.
Using the `cache-hit` output, subsequent steps (such as install or build) can be skipped when a cache hit occurs on the key. 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.

Example:
```yaml
Expand Down