Cache action (AWS S3)

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@v3 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.

Two other actions are available in addition to the primary cache action:

Restore action

Save action

Documentation

See "Caching dependencies to speed up workflows".

What's New

v3

Added support for caching in GHES 3.5+.
Fixed download issue for files > 2GB during restore.
Updated the minimum runner version support from node 12 -> node 16.
Fixed avoiding empty cache save when no files are available for caching.
Fixed tar creation error while trying to create tar with path as ~/ home folder on ubuntu-latest.
Fixed zstd failing on amazon linux 2.0 runners.
Fixed cache not working with github workspace directory or current directory.
Fixed the download stuck problem by introducing a timeout of 1 hour for cache downloads.
Fix zstd not working for windows on gnu tar in issues.
Allowing users to provide a custom timeout as input for aborting download of a cache segment using an environment variable SEGMENT_DOWNLOAD_TIMEOUT_MINS. Default is 10 minutes.
New actions are available for granular control over caches - restore and save.
Support cross-os caching as an opt-in feature. See Cross OS caching for more info.
Added option to fail job on cache miss. See Exit workflow on cache miss for more info.
Fix zstd not being used after zstd version upgrade to 1.5.4 on hosted runners
Added option to lookup cache without downloading it.
Reduced segment size to 128MB and segment timeout to 10 minutes to fail fast in case the cache download is stuck.

See the v2 README.md for older updates.

Usage

Pre-requisites

Create a workflow .yml file in your repository's .github/workflows directory. An example workflow is available below. For more information, see 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 from the execution path.

If you are using a self-hosted Windows runner, GNU tar and zstd are required for Cross-OS caching to work. They are also recommended to be installed in general so the performance is on par with hosted Windows runners.

Inputs

key - An explicit key for a cache entry. See creating a cache key.
path - A list of files, directories, and wildcard patterns to cache and restore. See @actions/glob for supported patterns.
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 - 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

SEGMENT_DOWNLOAD_TIMEOUT_MINS - Segment download timeout (in minutes, default 10) to abort download of the segment if not completed in the defined number of minutes. Read more

Outputs

cache-hit - A boolean value to indicate an exact match was found for the key.

Note cache-hit will only be set to true when a cache hit occurs for the exact key match. For a partial key match via restore-keys or a cache miss, it will be set to false.

See Skipping steps based on cache-hit for info on using this output

Cache scopes

The cache is scoped to the key, version, and branch. The default branch cache is available to other branches.

See Matching a cache key for more info.

Example cache workflow

Restoring and saving cache using a single action

name: Caching Primes

on: push

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3

    - name: Cache Primes
      id: cache-primes
      uses: justvanilla/shared-gha-cache-s3@v3
      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

The cache action provides a cache-hit output which is set to true when the cache is restored using the primary key and false when the cache is restored using restore-keys or no cache is restored.

Using a combination of restore and save actions

name: Caching Primes

on: push

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3

    - name: Restore cached Primes
      id: cache-primes-restore
      uses: actions/cache/restore@v3
      with:
        path: |
          path/to/dependencies
          some/other/dependencies
        key: ${{ runner.os }}-primes
    .
    . //intermediate workflow steps
    .
    - name: Save Primes
      id: cache-primes-save
      uses: actions/cache/save@v3
      with:
        path: |
          path/to/dependencies
          some/other/dependencies
        key: ${{ steps.cache-primes-restore.outputs.cache-primary-key }}

Note You must use the cache or restore action in your workflow before you need to use the files that might be restored from the cache. If the provided key matches an existing cache, a new cache is not created and if the provided key doesn't match an existing cache, a new cache is automatically created provided the job completes successfully.

Caching Strategies

With the introduction of the restore and save actions, a lot of caching use cases can now be achieved. Please see the caching strategies document for understanding how you can use the actions strategically to achieve the desired goal.

Implementation Examples

Every programming language and framework has its own way of caching.

See Examples for a list of actions/cache implementations for use with:

Creating a cache key

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: justvanilla/shared-gha-cache-s3@v3
    with:
      path: |
        path/to/dependencies
        some/other/dependencies
      key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
      aws-region: ${{ secrets.CACHE_AWS_REGION }}
      aws-bucket: ${{ secrets.CACHE_AWS_BUCKET }}
      aws-access-key-id: ${{ secrets.CACHE_AWS_ACCESS_KEY_ID }}
      aws-secret-access-key: ${{ secrets.CACHE_AWS_SECRET_ACCESS_KEY }}

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 "date=$(/bin/date -u "+%Y%m%d")" >> $GITHUB_OUTPUT
    shell: bash

  - uses: justvanilla/shared-gha-cache-s3@v3
    with:
      path: path/to/dependencies
      key: ${{ runner.os }}-${{ steps.get-date.outputs.date }}-${{ hashFiles('**/lockfiles') }}
      aws-region: ${{ secrets.CACHE_AWS_REGION }}
      aws-bucket: ${{ secrets.CACHE_AWS_BUCKET }}
      aws-access-key-id: ${{ secrets.CACHE_AWS_ACCESS_KEY_ID }}
      aws-secret-access-key: ${{ secrets.CACHE_AWS_SECRET_ACCESS_KEY }}

See Using contexts to create cache keys

Cache Limits

Since the data is stored to AWS bucket of your own management, you are the kin

Skipping steps based on cache-hit

Using the cache-hit output, subsequent steps (such as install or build) can be skipped when a cache hit occurs on the key. It is recommended to install missing/updated dependencies in case of a partial key match when the key is dependent on the hash of the package file.

Example:

steps:
  - uses: actions/checkout@v3

  - uses: justvanilla/shared-gha-cache-s3@v3
    id: cache
    with:
      path: path/to/dependencies
      key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
      aws-region: ${{ secrets.CACHE_AWS_REGION }}
      aws-bucket: ${{ secrets.CACHE_AWS_BUCKET }}
      aws-access-key-id: ${{ secrets.CACHE_AWS_ACCESS_KEY_ID }}
      aws-secret-access-key: ${{ secrets.CACHE_AWS_SECRET_ACCESS_KEY }}

  - name: Install Dependencies
    if: steps.cache.outputs.cache-hit != 'true'
    run: /install.sh

Note The id defined in actions/cache must match the id in the if statement (i.e. steps.[ID].outputs.cache-hit)

Cache Version

Cache version is a hash generated for a combination of compression tool used (Gzip, Zstd, etc. based on the runner OS) and the path of directories being cached. If two caches have different versions, they are identified as unique caches while matching. This, for example, means that a cache created on a windows-latest runner can't be restored on ubuntu-latest as cache Versions are different.

Pro tip: The list caches API can be used to get the version of a cache. This can be helpful to troubleshoot cache miss due to version.

Example

The workflow will create 3 unique caches with same keys. Ubuntu and windows runners will use different compression technique and hence create two different caches. And `build-linux` will create two different caches as the `paths` are different.

jobs:
  build-linux:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Cache Primes
        id: cache-primes
        uses: justvanilla/shared-gha-cache-s3@v3
        with:
          path: prime-numbers
          key: primes
          aws-region: ${{ secrets.CACHE_AWS_REGION }}
          aws-bucket: ${{ secrets.CACHE_AWS_BUCKET }}
          aws-access-key-id: ${{ secrets.CACHE_AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.CACHE_AWS_SECRET_ACCESS_KEY }}

      - name: Generate Prime Numbers
        if: steps.cache-primes.outputs.cache-hit != 'true'
        run: ./generate-primes.sh -d prime-numbers

      - name: Cache Numbers
        id: cache-numbers
        uses: justvanilla/shared-gha-cache-s3@v3
        with:
          path: numbers
          key: primes
          aws-region: ${{ secrets.CACHE_AWS_REGION }}
          aws-bucket: ${{ secrets.CACHE_AWS_BUCKET }}
          aws-access-key-id: ${{ secrets.CACHE_AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.CACHE_AWS_SECRET_ACCESS_KEY }}

      - name: Generate Numbers
        if: steps.cache-numbers.outputs.cache-hit != 'true'
        run: ./generate-primes.sh -d numbers

  build-windows:
    runs-on: windows-latest
    steps:
      - uses: actions/checkout@v3

      - name: Cache Primes
        id: cache-primes
        uses: justvanilla/shared-gha-cache-s3@v3
        with:
          path: prime-numbers
          key: primes
          aws-region: ${{ secrets.CACHE_AWS_REGION }}
          aws-bucket: ${{ secrets.CACHE_AWS_BUCKET }}
          aws-access-key-id: ${{ secrets.CACHE_AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.CACHE_AWS_SECRET_ACCESS_KEY }}

      - name: Generate Prime Numbers
        if: steps.cache-primes.outputs.cache-hit != 'true'
        run: ./generate-primes -d prime-numbers

Known practices and workarounds

There are a number of community practices/workarounds to fulfill specific requirements. You may choose to use them if they suit your use case. Note these are not necessarily the only solution or even a recommended solution.

Windows environment variables

Please note that Windows environment variables (like %LocalAppData%) will NOT be expanded by this action. Instead, prefer using ~ in your paths which will expand to the HOME directory. For example, instead of %LocalAppData%, use ~\AppData\Local. For a list of supported default environment variables, see the Learn GitHub Actions: Variables page.

Contributing

We would love for you to contribute to actions/cache. Pull requests are welcome! Please see the CONTRIBUTING.md for more information.

License

The scripts and documentation in this project are released under the MIT License

License

justvanilla/shared-gha-cache-s3

ErrorLooks like something went wrong!

About

Resources

License

Code of conduct

Uh oh!

Stars

Watchers

Forks

Releases 3

Packages 0

Uh oh!

Languages

Error
Looks like something went wrong!

Packages