cache/README.md

183 lines
7.1 KiB
Markdown
Raw Normal View History

2019-10-17 11:53:03 -04:00
# cache
2019-10-30 14:48:49 -04:00
This action allows caching dependencies and build outputs to improve workflow execution time.
2019-10-30 14:48:49 -04:00
2020-07-15 10:36:12 -04:00
<a href="https://github.com/actions/cache/actions?query=workflow%3ATests"><img alt="GitHub Actions status" src="https://github.com/actions/cache/workflows/Tests/badge.svg?branch=main&event=push"></a>
## Documentation
See ["Caching dependencies to speed up workflows"](https://help.github.com/github/automating-your-workflow-with-github-actions/caching-dependencies-to-speed-up-workflows).
2020-05-26 14:58:07 -04:00
## What's New
2020-05-26 12:45:38 -04:00
2020-07-15 10:36:12 -04:00
* Added support for multiple paths, [glob patterns](https://github.com/actions/toolkit/tree/main/packages/glob), and single file caches.
2020-05-26 12:45:38 -04:00
```yaml
2020-05-26 14:58:07 -04:00
- name: Cache multiple paths
2020-05-26 12:45:38 -04:00
uses: actions/cache@v2
with:
path: |
~/cache
2020-05-26 14:58:07 -04:00
!~/cache/exclude
2020-05-26 12:45:38 -04:00
key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
```
2020-05-26 14:58:07 -04:00
* 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](https://help.github.com/en/actions/reference/events-that-trigger-workflows) for info on which events do not have a `GITHUB_REF`
2020-07-15 10:36:12 -04:00
* Released the [`@actions/cache`](https://github.com/actions/toolkit/tree/main/packages/cache) npm package to allow other actions to utilize caching
2020-05-26 12:45:38 -04:00
* Added a best-effort cleanup step to delete the archive after extraction to reduce storage space
2020-05-26 14:58:07 -04:00
Refer [here](https://github.com/actions/cache/blob/v1/README.md) for previous versions
2019-10-30 14:48:49 -04:00
## Usage
### Pre-requisites
Create a workflow `.yml` file in your repositories `.github/workflows` directory. An [example workflow](#example-workflow) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#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.
2019-10-30 14:48:49 -04:00
### Inputs
2020-07-15 10:36:12 -04:00
* `path` - A list of files, directories, and wildcard patterns to cache and restore. See [`@actions/glob`](https://github.com/actions/toolkit/tree/main/packages/glob) for supported patterns.
2019-10-30 14:48:49 -04:00
* `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](#Skipping-steps-based-on-cache-hit) for info on using this output
### Cache scopes
The cache is scoped to the key and branch. The default branch cache is available to other branches.
See [Matching a cache key](https://help.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows#matching-a-cache-key) for more info.
2019-10-30 14:48:49 -04:00
### Example workflow
```yaml
name: Caching Primes
2019-10-30 14:48:49 -04:00
on: push
jobs:
build:
runs-on: ubuntu-latest
2019-10-30 14:48:49 -04:00
steps:
- uses: actions/checkout@v2
2019-10-30 14:48:49 -04:00
- name: Cache Primes
id: cache-primes
2020-05-26 12:45:38 -04:00
uses: actions/cache@v2
2019-10-30 14:48:49 -04:00
with:
path: prime-numbers
key: ${{ runner.os }}-primes
2019-10-30 14:48:49 -04:00
- 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
2019-10-30 14:48:49 -04:00
```
## Implementation Examples
Every programming language and framework has its own way of caching.
See [Examples](examples.md) for a list of `actions/cache` implementations for use with:
- [C# - Nuget](./examples.md#c---nuget)
2020-05-11 10:24:05 -04:00
- [D - DUB](./examples.md#d---dub)
- [Elixir - Mix](./examples.md#elixir---mix)
- [Go - Modules](./examples.md#go---modules)
- [Haskell - Cabal](./examples.md#haskell---cabal)
- [Java - Gradle](./examples.md#java---gradle)
- [Java - Maven](./examples.md#java---maven)
- [Node - npm](./examples.md#node---npm)
- [Node - Lerna](./examples.md#node---lerna)
- [Node - Yarn](./examples.md#node---yarn)
- [OCaml/Reason - esy](./examples.md#ocamlreason---esy)
- [PHP - Composer](./examples.md#php---composer)
- [Python - pip](./examples.md#python---pip)
2020-10-22 21:04:58 -04:00
- [Python - pipenv](./examples.md#python---pipenv)
- [R - renv](./examples.md#r---renv)
- [Ruby - Bundler](./examples.md#ruby---bundler)
- [Rust - Cargo](./examples.md#rust---cargo)
- [Scala - SBT](./examples.md#scala---sbt)
- [Swift, Objective-C - Carthage](./examples.md#swift-objective-c---carthage)
- [Swift, Objective-C - CocoaPods](./examples.md#swift-objective-c---cocoapods)
- [Swift - Swift Package Manager](./examples.md#swift---swift-package-manager)
2019-10-31 10:45:47 -04:00
## 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`](https://help.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#hashfiles) function allows you to create a new cache when dependencies change.
```yaml
2020-05-26 12:45:38 -04:00
- uses: actions/cache@v2
with:
2020-05-26 12:45:38 -04:00
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:
```yaml
# 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
2020-05-26 12:45:38 -04:00
- 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](https://help.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows#using-contexts-to-create-cache-keys)
2019-10-30 14:48:49 -04:00
## Cache Limits
2021-11-23 11:05:12 -05:00
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.
2019-10-30 14:48:49 -04:00
## 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:
```yaml
steps:
2020-03-18 09:44:24 -04:00
- uses: actions/checkout@v2
2019-10-30 14:48:49 -04:00
2020-05-26 12:45:38 -04:00
- uses: actions/cache@v2
2019-10-30 14:48:49 -04:00
id: cache
with:
path: path/to/dependencies
2019-11-12 15:33:22 -05:00
key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
2019-10-30 14:48:49 -04:00
- 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`)
2019-10-30 14:48:49 -04:00
2021-11-29 09:51:07 -05:00
## Known limitation
- `action/cache` is currently not supported on GitHub Enterprise Server. <https://github.com/github/roadmap/issues/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.
2021-11-29 09:51:07 -05:00
2019-10-30 14:48:49 -04:00
## Contributing
We would love for you to contribute to `actions/cache`, pull requests are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
2019-10-30 14:48:49 -04:00
## License
The scripts and documentation in this project are released under the [MIT License](LICENSE)