actions
/
cache
mirror of https://github.com/actions/cache.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1 from hipcamp/documentation

Browse Source 
Update README
pull/676/head
Caleb Gosiak 4 years ago committed by GitHub
parent efa512101d d744ca3666
commit d18e25fa75
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 83 additions and 119 deletions
Show Stats Download Patch File Download Diff File

202
README.md
Unescape Escape View File

@ -1,34 +1,3 @@
# cache
This action allows caching dependencies and build outputs to improve workflow execution time.
<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).
## What's New
* Added support for multiple paths, [glob patterns](https://github.com/actions/toolkit/tree/main/packages/glob), and single file caches.
```yaml
- 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](https://help.github.com/en/actions/reference/events-that-trigger-workflows) for info on which events do not have a `GITHUB_REF`
* Released the [`@actions/cache`](https://github.com/actions/toolkit/tree/main/packages/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](https://github.com/actions/cache/blob/v1/README.md) for previous versions
## Usage
### Pre-requisites
@ -39,13 +8,15 @@ Create a workflow `.yml` file in your repositories `.github/workflows` directory
* `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.
* `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
* `bucket` - aws s3 bucket
* `access-key-id` - aws access key id *OPTIONAL*
* `secret-access-key` - aws secret access key *OPTIONAL*
### 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.
@ -54,121 +25,114 @@ See [Matching a cache key](https://help.github.com/en/actions/configuring-and-ma
### Example workflow
```yaml
name: Caching Primes
name: Caching Node Modules
on: push
jobs:
build:
build-with-cache:
name: NPM Install with Cache
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Cache Primes
id: cache-primes
uses: actions/cache@v2
- name: Checkout Repo
uses: actions/checkout@v2
- uses: hipcamp/cache@v0.13.0
id: node-cache
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
bucket: [your cache bucket]
path: node_modules
key: node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
node-
- run: npm install
```
## Implementation Examples
## Skipping steps based on cache-hit
Every programming language and framework has its own way of caching.
Using the `cache-hit` output, subsequent steps (such as install or build) can be skipped when a cache hit occurs on the key.
See [Examples](examples.md) for a list of `actions/cache` implementations for use with:
Example:
```yaml
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
```
- [C# - Nuget](./examples.md#c---nuget)
- [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)
- [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)
> Note: The `id` defined in `actions/cache` must match the `id` in the `if` statement (i.e. `steps.[ID].outputs.cache-hit`)
## Creating a cache key
## How to Contribute
A cache key can include any of the contexts, functions, literals, and operators supported by GitHub Actions.
> First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance.
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.
Install the dependencies
```bash
$ npm install
```
```yaml
- uses: actions/cache@v2
with:
path: |
path/to/dependencies
some/other/dependencies
key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
Build the typescript and package it for distribution
```bash
$ npm run build && npm run package
```
Additionally, you can use arbitrary command output in a cache key, such as a date or software version:
Run the tests :heavy_check_mark:
```bash
$ npm test
```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
PASS ./index.test.js
✓ throws invalid number (3ms)
✓ wait 500 ms (504ms)
✓ test runs (95ms)
- 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)
## Change action.yml
## Cache Limits
The action.yml contains defines the inputs and output for your action.
A repository can have up to 5GB of caches. Once the 5GB 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.
Update the action.yml with your name, description, inputs and outputs for your action.
## Skipping steps based on cache-hit
See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
Using the `cache-hit` output, subsequent steps (such as install or build) can be skipped when a cache hit occurs on the key.
## Change the Code
Example:
```yaml
steps:
- uses: actions/checkout@v2
Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
- uses: actions/cache@v2
id: cache
with:
path: path/to/dependencies
key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
```javascript
import * as core from '@actions/core';
...
- name: Install Dependencies
if: steps.cache.outputs.cache-hit != 'true'
run: /install.sh
async function run() {
try {
...
}
catch (error) {
core.setFailed(error.message);
}
}
run()
```
> Note: The `id` defined in `actions/cache` must match the `id` in the `if` statement (i.e. `steps.[ID].outputs.cache-hit`)
See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
## Publish to a Distribution Branch
Actions are run from GitHub repos so we will checkin the packed dist folder.
```bash
$ npm run all
$ git add -A
$ git commit -m "your commit message"
$ git tag v[version from package.json]
$ git push origin v[version from package.json]
```
## 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.
Your action is now published! :rocket:
## License
The scripts and documentation in this project are released under the [MIT License](LICENSE)
See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)

Write Preview
Loading…
Cancel
Save