coursier/coursier-cache-action

Restores and saves the coursier cache

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
rootRoot directory containing build definition sources (build.sbt, build.mill, etc.) If the sbt or mill build definition files are in a sub-directory, pass the path to this sub-directory here. no.
pathOverride for the path of the coursier cache. By default, the coursier cache is assumed to be in the default OS-dependent location. Set this input to override that. Note that this action will also set COURSIER_CACHE if an override is specified, so that you don't have to set it yourself. no""
jobJob name, to be used in the cache key, so that each job has its own cache. no${{ github.job }}
matrixMatrix values, when using the matrix strategy. When using build matrices for more than the OS (for Scala versions, JDKs, test suites, …), pass the matrix values here, with `matrix: -dollar-{{ toJson(matrix) }}`. The matrix instance is hashed, and added to the cache key, so that each matrix instance has its own cache, and those caches don't collide. no${{ toJson(matrix) }}
extraFilesExtra 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 (*.mill, ./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)). no""
extraKeyExtra value to be appended to the coursier cache key. See extraFiles for more details. no""
extraHashedContentExtra 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. no""
extraSbtFilesExtra sbt files to take into account in the sbt cache key. Same format as extraFiles. no""
extraSbtKeyExtra value to be appended to the sbt cache key. See extraFiles for more details. no""
extraSbtHashedContentExtra content to take into account in the sbt cache key. Same format as extraHashedContent. no""
extraMillFilesExtra mill files to take into account in the mill cache key. Same format as extraFiles. no""
extraMillKeyExtra value to be appended to the mill cache key. See extraFiles for more details. no""
extraMillHashedContentExtra content to take into account in the mill cache key. Same format as extraHashedContent. no""
ammoniteScriptsAmmonite scripts to take into account in the Ammonite cache key. Same format as extraFiles. no""
extraAmmoniteKeyExtra value to be appended to the Ammonite cache key. See extraFiles for more details. no""
extraAmmoniteHashedContentExtra content to take into account in the Ammonite cache key. Same format as extraHashedContent. no""
ignoreJobSet 'true' if you don't want to use a job id as part of cache key. nofalse
ignoreMatrixSet 'true' if you don't want to use a matrix jobs as part of cache key. nofalse
ignoreAmmoniteSet 'true' to skip saving and restoring the Ammonite cache, regardless of whether the repository contains .sc scripts. nofalse
disableFallbackSet 'true' to disable falling back to a less specific cache key when there is no exact cache hit. By default, if no exact cache match is found, the action will restore from a more general cache key (e.g. from a different job or build configuration). Disabling this prevents unintended cache sharing across jobs or matrix instances that have different dependency sets. nofalse
namedescription
cache-hit-coursierA boolean value to indicate a match was found for the coursier cache
cache-hit-sbt-ivy2-cacheA boolean value to indicate a match was found for the sbt-ivy2-cache cache
cache-hit-millA boolean value to indicate a match was found for the mill cache
cache-hit-ammoniteA boolean value to indicate a match was found for the ammonite cache