Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
penandlim committed Feb 22, 2024
1 parent 042cfbf commit 0bbe76e
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
| `cache` | No | `true` | Whether to cache RPC responses or not. | bool |
| `version` | No | `nightly` | Version to install, e.g. `nightly` or `1.0.0`. **Note:** Foundry only has nightly builds for the time being. | string |
| `cache-key` | No | `${{ github.job }}-${{ github.sha }}` | The cache key to use for caching. | string |
| `cache-restore-keys` | No | `${{ github.job }}-` | The cache key to use for restoring the cache. | string[] |
| `cache-restore-keys` | No | `[${{ github.job }}-]` | The cache keys to use for restoring the cache. | string[] |

### RPC Caching

Expand Down Expand Up @@ -74,21 +74,21 @@ For example, to share the cache across two different jobs, you could do somethin
with:
cache-key: custom-seed-test-${{ github.sha }}
cache-restore-keys: |-
custom-seed-test
custom-seed-test-
custom-seed-
---
- name: Install Foundry
uses: foundry-rs/foundry-toolchain@v1
with:
cache-key: custom-seed-coverage-${{ github.sha }}
cache-restore-keys: |-
custom-seed-coverage
custom-seed-coverage-
custom-seed-
```

This will create two different caches, one for each job, but they will share the same cache key prefix. This means that
when restoring the cache in the second job, it will look for caches with keys that start with `custom-seed-`. This
allows you to share the cache across different jobs, or across different workflows if desired.
when restoring the cache in the second job, it will look for caches with keys that start with `custom-seed-` as well.
This allows you to share the cache across different jobs, or across different workflows if desired.

#### Deleting Caches

Expand Down

0 comments on commit 0bbe76e

Please sign in to comment.