From 13b9765ae124272c9a8e1c0f0a8f768a3baee500 Mon Sep 17 00:00:00 2001 From: Boris Staal Date: Sun, 9 Apr 2023 12:56:22 -0500 Subject: [PATCH] Update README.md --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2e129f1..87e9a4e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,19 @@ -# Cache action +# Cache action (S3 fork) + + + +> This repo is a drop-in replacement for standard cache action to make it use AWS S3. You can replace cache calls with `uses: justvanilla/shared-gha-cache@s3` directly. Default behavior will be identical. To make task use S3 bucket instead, provide the following inputs: +> * **aws-region**: us-east-1 +> * **aws-bucket**: the-bucketest-bucket +> * **aws-access-key-id**: key id for account having RW access to the bucket +> * **aws-secret-access-key**: secret for account having RW access to the bucket + +> **Note** +> Action is supported and periodically rebased against original 👍 + +Lots of the backend is based on https://github.com/whywaita/actions-cache-s3 ❤️ + +---------------- This action allows caching dependencies and build outputs to improve workflow execution time. @@ -54,7 +69,11 @@ If you are using a `self-hosted` Windows runner, `GNU tar` and `zstd` are requir * `restore-keys` - An ordered list of prefix-matched keys to use for restoring stale cache if no cache hit occurred for key. * `enableCrossOsArchive` - An optional boolean when enabled, allows Windows runners to save or restore caches that can be restored or saved respectively on other platforms. Default: `false` * `fail-on-cache-miss` - Fail the workflow if cache entry is not found. Default: `false` -* `lookup-only` - Skip downloading cache. Only check if cache entry exists. Default: `false` +* `lookup-only` - If true, only checks if cache entry exists and skips download. Does not change save cache behavior. Default: `false` +* `aws-region` - Region in which S3 Bucket is located +* `aws-bucket` - S3 Bucket to use +* `aws-access-key-id` - key id for account having RW access to the bucket +* `aws-secret-access-key` - secret for account having RW access to the bucket #### Environment Variables