Go to file
Josh Gross bc821d0c12
Remove recommendation to cache node_modules (#69)
* Update npm caching examples

* Fix output name

* Remove extra details tag
2019-11-07 21:04:46 -05:00
__tests__ Add unit tests for restore (#62) 2019-11-06 13:41:45 -05:00
.github/workflows Fix PR filters 2019-11-07 20:02:06 -05:00
.vscode Initial commit 2019-10-30 14:48:49 -04:00
src Add unit tests for restore (#62) 2019-11-06 13:41:45 -05:00
.gitignore Initial commit 2019-10-30 14:48:49 -04:00
.prettierrc.json Initial commit 2019-10-30 14:48:49 -04:00
action.yml Initial commit 2019-10-30 14:48:49 -04:00
CODE_OF_CONDUCT.md Fix repo name in contact email (#41) 2019-11-03 09:38:45 -05:00
CONTRIBUTING.md Initial commit 2019-10-30 14:48:49 -04:00
examples.md Remove recommendation to cache node_modules (#69) 2019-11-07 21:04:46 -05:00
jest.config.js Add unit tests for restore (#62) 2019-11-06 13:41:45 -05:00
LICENSE Initial commit 2019-10-30 14:48:49 -04:00
package-lock.json Add unit tests for restore (#62) 2019-11-06 13:41:45 -05:00
package.json Add unit tests for restore (#62) 2019-11-06 13:41:45 -05:00
README.md Remove recommendation to cache node_modules (#69) 2019-11-07 21:04:46 -05:00
tsconfig.json Initial commit 2019-10-30 14:48:49 -04:00

cache

This GitHub Action allows caching dependencies and build outputs to improve workflow execution time.

GitHub Actions status

Documentation

See "Caching dependencies to speed up workflows".

Usage

Pre-requisites

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.

Inputs

  • path - A directory to store and save the cache
  • key - An explicit key for restoring and saving the cache
  • restore-keys - An ordered list of keys to use for restoring the cache if no cache hit occurred for key

Outputs

  • 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

Example workflow

name: Caching Primes

on: push

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

    - name: Cache Primes
      id: cache-primes
      uses: actions/cache@v1
      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

Ecosystem Examples

See Examples

Cache Limits

Individual caches are limited to 400MB and a repository can have up to 2GB of caches. Once the 2GB 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.

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.

Example:

steps:
  - uses: actions/checkout@v1

  - uses: actions/cache@v1
    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 in actions/cache must match the id in the if statement (i.e. steps.[ID].outputs.cache-hit)

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