2022-02-14 11:02:36 +01:00
name : 'Cache S3'
description : 'actions/cache@v2 for AWS S3 and compatible software (forked Actions)'
author : 'whywaita'
2019-10-30 19:48:49 +01:00
inputs :
path :
2020-05-26 20:58:07 +02:00
description : 'A list of files, directories, and wildcard patterns to cache and restore'
2019-10-30 19:48:49 +01:00
required : true
key :
description : 'An explicit key for restoring and saving the cache'
required : true
restore-keys :
2021-03-26 00:36:55 +01:00
description : 'An ordered list of keys to use for restoring stale cache if no cache hit occurred for key. Note `cache-hit` returns false in this case.'
2019-10-30 19:48:49 +01:00
required : false
2020-10-02 18:01:24 +02:00
upload-chunk-size :
2020-10-02 18:22:20 +02:00
description : 'The chunk size used to split up large files during upload, in bytes'
2020-10-02 18:01:24 +02:00
required : false
2023-01-05 12:19:13 +01:00
enableCrossOsArchive :
description : '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'
required : false
2023-01-30 12:10:58 +01:00
fail-on-cache-miss :
description : 'Fail the workflow if cache entry is not found'
default : 'false'
required : false
2023-03-09 13:30:28 +01:00
lookup-only :
description : 'Check if a cache entry exists for the given input(s) (key, restore-keys) without downloading the cache'
default : 'false'
required : false
2022-02-14 10:51:41 +01:00
aws-s3-bucket :
description : 'An AWS S3 bucket to save cache'
required : true
aws-access-key-id :
description : 'An AWS access key id to access the bucket'
2023-10-31 17:34:48 +01:00
required : false
2022-02-14 10:51:41 +01:00
aws-secret-access-key :
description : 'An AWS secret access key to access the bucket'
2023-10-31 17:34:48 +01:00
required : false
2022-02-14 10:51:41 +01:00
aws-region :
description : 'An AWS region where the bucket is located'
required : false
aws-endpoint :
description : 'An endpoint of AWS S3 (for compatible software)'
required : false
aws-s3-bucket-endpoint :
description : 'Whether to use the bucket name as the endpoint for this request.'
required : false
2023-08-31 19:04:54 +02:00
default : 'true'
2022-02-14 10:51:41 +01:00
aws-s3-force-path-style :
description : 'Whether to force path style URLs for S3 objects.'
required : false
2023-08-31 19:04:54 +02:00
default : 'false'
2019-10-30 19:48:49 +01:00
outputs :
cache-hit :
description : 'A boolean value to indicate an exact match was found for the primary key'
runs :
2023-03-20 03:58:12 +01:00
using : 'node16'
2019-10-30 19:48:49 +01:00
main : 'dist/restore/index.js'
post : 'dist/save/index.js'
2022-12-21 15:08:44 +01:00
post-if : success()
2019-10-30 19:48:49 +01:00
branding :
icon : 'archive'
2020-01-14 16:11:41 +01:00
color : 'gray-dark'