actions
/
cache
mirror of https://github.com/actions/cache.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

pull/1662/head
Cyril Rohr 2024-02-14 11:48:02 +01:00 committed by GitHub
parent 4158181224
commit 1eca6adfda
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -10,9 +10,31 @@ Also note that you no longer have any limit on the size of the cache. The bucket
If no S3 bucket is provided, it will also transparently switch to the default behaviour. This means you can use this action and switch between RunsOn runners and official GitHub runners with no change.
## Usage with RunsOn
## Usage
If using [RunsOn](https://runs-on.com), simply replace `actions/cache@v4` with `runs-on/cache@v4`. All the official options are supported.
Simply replace `actions/cache@v4` with `runs-on/cache@v4`. All the official options are supported.
```diff
- - uses: actions/cache@v4
+ - uses: runs-on/cache@v4
with:
...
```
Please refer to [actions/cache](https://github.com/actions/cache) for usage.
## Usage outside RunsOn
If you want to use this in your own infrastructure, setup your AWS credentials with [aws-actions/configure-aws-credentials](https://github.com/aws-actions/configure-aws-credentials), then:
```yaml
- uses: aws-actions/configure-aws-credentials@v4
...
- uses: runs-on/cache@v4
with:
...
env:
RUNS_ON_S3_BUCKET_CACHE: name-of-your-bucket
```
Be aware of S3 transfer costs if your runners are not in the same AWS region as your bucket.