Cache dependencies and build outputs in Gitea Actions
Go to file
Josh Gross 0da99ad140
Preview v0.0.2 Release (#50)
* Create CODE_OF_CONDUCT.md

* Update workflow (#1)

* Run workflow on linux, mac, and windows

* Add status badge

* Use npm install instead

* Bump typescript version

* Use node 12.x

* Add Ruby Gem example (#4)

* Add Cocoapods example (#5)

* Add Carthage example (#10)

* Move examples to their own page (#13)

* Minor typo in README (#15)

from `steps.[ID].outupts.cache-hit` to `steps.[ID].outputs.cache-hit`

* Update README.md

* Prevent commands from executing during tests (#21)

* Prevent commands from executing during tests

* Add newline at end of file

* Drop all commands from output

* Link to NuGet lock files documentation (#20)

* Add trailing dash to Maven fallback key (#19)

* Fix README.md (#25)

`restore-keys` had incorrect indentation.

* Exclude documentation from CI tests (#28)

* Ignore all .md files

* Add note about time-based eviction to README (#30)

* Fix typo in error message (#29)

* Time based eviction interval is 1 week (#34)

* Remove cache checksum debug - close #24 (#26)

* Remove cache checksum debug - close #24

*  Remove cache checksum debug on save

* Fix formatting

* Add Go modules example (#18)

* Add Go modules example

* Fix TOC

* Fix repo name in contact email (#41)

* Add Elixir Mix example (#42)

* Add Elixir Mix example

* Fix typo

* Add cargo example for Rust project (#8)

* Add cargo example

* Add hash of Cargo.lock to keys of caches

* Move Rust example to examples.md

* Stop warning when cache is not found (#40)

The cache not being found is a common situation so very visible warning
is a little too much.

* Bump package version

* Release v0.0.2
2019-11-04 13:39:29 -05:00
.github/workflows Preview v0.0.2 Release (#50) 2019-11-04 13:39:29 -05:00
.vscode Initial commit 2019-10-30 14:48:49 -04:00
__tests__ Initial commit 2019-10-30 14:48:49 -04:00
dist Preview v0.0.2 Release (#50) 2019-11-04 13:39:29 -05:00
src Preview v0.0.2 Release (#50) 2019-11-04 13:39:29 -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
CODE_OF_CONDUCT.md Preview v0.0.2 Release (#50) 2019-11-04 13:39:29 -05:00
CONTRIBUTING.md Initial commit 2019-10-30 14:48:49 -04:00
LICENSE Initial commit 2019-10-30 14:48:49 -04:00
README.md Preview v0.0.2 Release (#50) 2019-11-04 13:39:29 -05:00
action.yml Initial commit 2019-10-30 14:48:49 -04:00
examples.md Preview v0.0.2 Release (#50) 2019-11-04 13:39:29 -05:00
jest.config.js Preview v0.0.2 Release (#50) 2019-11-04 13:39:29 -05:00
package-lock.json Preview v0.0.2 Release (#50) 2019-11-04 13:39:29 -05:00
package.json Preview v0.0.2 Release (#50) 2019-11-04 13:39:29 -05:00
tsconfig.json Initial commit 2019-10-30 14:48:49 -04:00

README.md

cache

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

GitHub Actions status

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: Example Caching with npm

on: push

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

    - name: Cache node modules
      uses: actions/cache@preview
      with:
        path: node_modules
        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
        restore-keys: |
          ${{ runner.os }}-node-          

    - name: Install Dependencies
      run: npm install
    
    - name: Build
      run: npm run build

    - name: Test
      run: npm run test

Ecosystem Examples

See Examples

Cache Limits

Individual caches are limited to 200MB 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@preview
    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