itchyny/Cache files to Amazon S3
GitHub Action to save cache files and restore them from Amazon S3
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jun 26, 2026
- License
- MIT
Pinned Snippet
uses: itchyny/s3-cache-action@f7700c3ec7b3b81412e35f1d6cb00ca27b3094dd # v1.1.6tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| path | A list of file paths or glob patterns to save and restore | yes | — |
| key | A key to use for restoring and saving the files | yes | — |
| restore-keys | An ordered list of keys to use for restoring the files | no | — |
| lookup-only | A boolean value indicating whether to lookup without downloading the cache | no | — |
| fail-on-cache-miss | A boolean value indicating whether to fail if the cache is not found | no | — |
| bucket-name | Bucket name to save and restore cache files | yes | — |
| aws-region | AWS region of the bucket | no | — |
| aws-access-key-id | AWS access key ID to access the bucket | no | — |
| aws-secret-access-key | AWS secret access key to access the bucket | no | — |
| aws-session-token | AWS session token to access the bucket | no | — |
Outputs
| name | description |
|---|---|
| cache-hit | A string "true" or "false" indicating whether the cache hit with the key. If the cache is restored with one of the restore-keys, the value is "false". If the cache is not restored, the value is "". |