Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coursier/cache-action
GitHub action to save / restore the coursier cache of your build
https://github.com/coursier/cache-action
Last synced: 4 days ago
JSON representation
GitHub action to save / restore the coursier cache of your build
- Host: GitHub
- URL: https://github.com/coursier/cache-action
- Owner: coursier
- License: mit
- Created: 2020-08-14T16:07:01.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-02T09:49:03.000Z (6 months ago)
- Last Synced: 2024-12-14T00:06:48.668Z (11 days ago)
- Language: Shell
- Homepage:
- Size: 14.3 MB
- Stars: 63
- Watchers: 5
- Forks: 23
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# coursier cache action
A GitHub action to save / restore the coursier / sbt / mill / Ammonite caches of your build.
## Usage
Add a `coursier/cache-action@v6` step to your YAML workflow, like
```yaml
steps:
- uses: actions/checkout@v4
- uses: coursier/cache-action@v6
```
## Cached directories
### Coursier cache
Always cached.
Add files to take into account in its cache key via [`extraFiles`](#extrafiles).
### `~/.sbt` and `~/.ivy2/cache`
Cached when sbt files are found (any of `*.sbt`, `project/**.scala`, `project/**.sbt`, `project/build.properties`).
Add files to take into account in its cache key via [`extraSbtFiles`](#extrasbtfiles).
### `~/.cache/mill`
Cached when mill files are found (any of `.mill-version`, `./mill`).
Add files to take into account in its cache key via [`extraMillFiles`](#extramillfiles).
### `~/.ammonite`
Cached when Ammonite scripts are found (any of `*.sc`, `*/*.sc`).
Add files to take into account in its cache key via [`ammoniteScripts`](#ammonitescripts).
## Parameters
### `root`
*Optional* Root directory containing build definition sources (`build.sbt`, `build.sc`, etc.)
If the sbt or mill build definition files are in a sub-directory, pass the path to this
sub-directory here.
### `path`
*Optional* Override for the path of the coursier cache.
By default, the coursier cache is assumed to be in the [default OS-dependent location](https://get-coursier.io/docs/cache.html#default-location).
Set this input to override that. Note that this action will also set the `COURSIER_CACHE` environment variable
if an override is specified, so that you don't have to set it yourself.
### `extraFiles`
*Optional* Extra files to take into account in the cache key.
By default, sbt build definition files (`*.sbt`, `project/**.{scala,sbt}`, `project/build.properties`) and
mill build definition files (`*.sc`, `./mill`) are hashed to uniquely identify the cached data. Upon
cache restoration, if an exact match is found, the cache is not saved again at the end of the job.
In case of no exact match, it is assumed new files may have been fetched; the previous cache for the
current OS, if any, is restored, but a new cache is persisted with a new key at the end of the job.
To take into account extra files in the cache key, pass via `extraFiles` either
- a single path as a string
- multiple paths in a JSON array, encoded in a string
Blobs are accepted (processed by [@actions/glob](https://www.npmjs.com/package/@actions/glob)).
### `extraSbtFiles`
*Optional* Extra sbt files to take into account in the sbt cache key. Same format as extraFiles.
### `extraMillFiles`
*Optional* Extra mill files to take into account in the mill cache key. Same format as extraFiles.
### `ammoniteScripts`
*Optional* Extra Ammonite scripts to take into account in the Ammonite cache key. Same format as extraFiles.
### `extraKey`
*Optional*
Extra value to be appended to the coursier cache key.
See `extraFiles` for more details.
### `extraHashedContent`
*Optional*
Extra content to take into account in the cache key.
See `extraFiles` for more details.
The content of `extraHashedContent` is taken into account in the hash for the coursier cache key.
### `ignoreJob`
*Optional*
Default: `false`
Set `true` if you don't want to use a job id as part of cache key.
### `ignoreMatrix`
*Optional*
Default: `false`
Set `true` if you don't want to use a matrix jobs as part of cache key.
## Outputs
* `cache-hit-coursier` - A boolean value to indicate a match was found for the coursier cache
* `cache-hit-sbt-ivy2-cache` - A boolean value to indicate a match was found for the sbt-ivy2-cache cache
* `cache-hit-mill` - A boolean value to indicate a match was found for the mill cache
* `cache-hit-ammonite` - A boolean value to indicate a match was found for the ammonite cache
> See [Skipping steps based on cache-hit](#Skipping-steps-based-on-cache-hit) for info on using this output
## Skipping steps based on cache-hit
Using the `cache-hit-...` outputs above, subsequent steps can be skipped when a cache hit occurs on a given key.
Example:
```yaml
steps:
- uses: actions/checkout@v3
- uses: coursier/cache-action@v6
id: coursier-cache
- name: Fetch Dependencies
if: steps.coursier-cache.outputs.cache-hit-coursier != 'true'
run: sbt +update
```
> Note: The `id` defined in `coursier/cache-action` must match the `id` in the `if` statement (i.e. `steps.[ID].outputs.cache-hit-coursier`)