actions/setup-java
2
0
Fork 0
mirror of https://github.com/actions/setup-java.git synced 2025-04-21 02:16:45 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updates the sbt cache docs in the README

Browse source 
The README's description of sbt's cache behaviour does not match the
implementation. An `sbt` build can be modified from multiple places
and the current cache invalidation behaviour correctly captures these
cases. The README only mentions `build.sbt` files, which might mean
teams with more experience using `sbt` unnecessarily add their own
cache patterns here.

Here's the (current) implementation, for reference:
860f600565/src/cache.ts (L43)
This commit is contained in:
Adam Fisher 2022-05-06 17:49:33 +01:00
parent 860f600565
commit d31abef008
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -70,7 +70,7 @@ Currently, the following distributions are supported:
The action has a built-in functionality for caching and restoring dependencies. It uses [actions/cache](https://github.com/actions/cache) under hood for caching dependencies but requires less configuration settings. Supported package managers are gradle, maven and sbt. The format of the used cache key is `setup-java-${{ platform }}-${{ packageManager }}-${{ fileHash }}`, where the hash is based on the following files: The action has a built-in functionality for caching and restoring dependencies. It uses [actions/cache](https://github.com/actions/cache) under hood for caching dependencies but requires less configuration settings. Supported package managers are gradle, maven and sbt. The format of the used cache key is `setup-java-${{ platform }}-${{ packageManager }}-${{ fileHash }}`, where the hash is based on the following files:
- gradle: `**/*.gradle*`, `**/gradle-wrapper.properties` - gradle: `**/*.gradle*`, `**/gradle-wrapper.properties`
- maven: `**/pom.xml` - maven: `**/pom.xml`
- sbt: `**/build.sbt` - sbt: all sbt build definition files `**/*.sbt`, `**/project/build.properties`, `**/project/**.{scala,sbt}`
The workflow output `cache-hit` is set to indicate if an exact match was found for the key [as actions/cache does](https://github.com/actions/cache/tree/main#outputs). The workflow output `cache-hit` is set to indicate if an exact match was found for the key [as actions/cache does](https://github.com/actions/cache/tree/main#outputs).