whywaita/actions-cache-s3
is a forked Action from @actions/cache.
This Action provides Amazon Web Services S3 backend (and compatible software) for @actions/cache.
- name: Cache multiple paths
uses: whywaita/actions-cache-s3@v2
with:
path: |
~/cache
!~/cache/exclude
key: ${{ github.repository }}-${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
restore-keys: |
${{ github.repository }}-${{ runner.os }}-go-
aws-s3-bucket: ${{ secrets.AWS_S3_BUCKET_NAME }}
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: us-east-1 # Optional
aws-endpoint: https://example.com # Optional
aws-s3-bucket-endpoint: false # Optional
aws-s3-force-path-style: true # Optional
Please see actions.yml about input parameters.
This action allows caching dependencies and build outputs to improve workflow execution time.
See "Caching dependencies to speed up workflows".
- Added support for multiple paths, glob patterns, and single file caches.
- name: Cache multiple paths
uses: actions/cache@v2
with:
path: |
~/cache
!~/cache/exclude
key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
- Increased performance and improved cache sizes using
zstd
compression for Linux and macOS runners - Allowed caching for all events with a ref. See events that trigger workflow for info on which events do not have a
GITHUB_REF
- Released the
@actions/cache
npm package to allow other actions to utilize caching - Added a best-effort cleanup step to delete the archive after extraction to reduce storage space
Refer here for previous versions
Create a workflow .yml
file in your repositories .github/workflows
directory. An example workflow is available below. For more information, reference the GitHub Help Documentation for Creating a workflow file.
If you are using this inside a container, a POSIX-compliant tar
needs to be included and accessible in the execution path.
path
- A list of files, directories, and wildcard patterns to cache and restore. See@actions/glob
for supported patterns.key
- An explicit key for restoring and saving the cacherestore-keys
- An ordered list of keys to use for restoring the cache if no cache hit occurred for key
cache-hit
- A boolean value to indicate an exact match was found for the key
See Skipping steps based on cache-hit for info on using this output
The cache is scoped to the key and branch. The default branch cache is available to other branches.
See Matching a cache key for more info.
name: Caching Primes
on: push
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Cache Primes
id: cache-primes
uses: actions/cache@v2
with:
path: prime-numbers
key: ${{ runner.os }}-primes
- name: Generate Prime Numbers
if: steps.cache-primes.outputs.cache-hit != 'true'
run: /generate-primes.sh -d prime-numbers
- name: Use Prime Numbers
run: /primes.sh -d prime-numbers
Every programming language and framework has its own way of caching.
See Examples for a list of actions/cache
implementations for use with:
- C# - Nuget
- D - DUB
- Elixir - Mix
- Go - Modules
- Haskell - Cabal
- Java - Gradle
- Java - Maven
- Node - npm
- Node - Lerna
- Node - Yarn
- OCaml/Reason - esy
- PHP - Composer
- Python - pip
- Python - pipenv
- R - renv
- Ruby - Bundler
- Rust - Cargo
- Scala - SBT
- Swift, Objective-C - Carthage
- Swift, Objective-C - CocoaPods
- Swift - Swift Package Manager
A cache key can include any of the contexts, functions, literals, and operators supported by GitHub Actions.
For example, using the hashFiles
function allows you to create a new cache when dependencies change.
- uses: actions/cache@v2
with:
path: |
path/to/dependencies
some/other/dependencies
key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
Additionally, you can use arbitrary command output in a cache key, such as a date or software version:
# http://man7.org/linux/man-pages/man1/date.1.html
- name: Get Date
id: get-date
run: |
echo "::set-output name=date::$(/bin/date -u "+%Y%m%d")"
shell: bash
- uses: actions/cache@v2
with:
path: path/to/dependencies
key: ${{ runner.os }}-${{ steps.get-date.outputs.date }}-${{ hashFiles('**/lockfiles') }}
See Using contexts to create cache keys
A repository can have up to 10GB of caches. Once the 10GB limit is reached, older caches will be evicted based on when the cache was last accessed. Caches that are not accessed within the last week will also be evicted.
Using the cache-hit
output, subsequent steps (such as install or build) can be skipped when a cache hit occurs on the key.
Example:
steps:
- uses: actions/checkout@v2
- uses: actions/cache@v2
id: cache
with:
path: path/to/dependencies
key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
- name: Install Dependencies
if: steps.cache.outputs.cache-hit != 'true'
run: /install.sh
Note: The
id
defined inactions/cache
must match theid
in theif
statement (i.e.steps.[ID].outputs.cache-hit
)
action/cache
is currently not supported on GitHub Enterprise Server. github/roadmap#273 is tracking this.
Since GitHub Enterprise Server uses self-hosted runners, dependencies are typically cached on the runner by whatever dependency management tool is being used (npm, maven, etc.). This eliminates the need for explicit caching in some scenarios.
We would love for you to contribute to actions/cache
, pull requests are welcome! Please see the CONTRIBUTING.md for more information.
The scripts and documentation in this project are released under the MIT License