Stack Cache Action

Cache step for Stack-based Haskell projects on GitHub Actions.

NOTE: if you are using freckle/stack-action@v4 or newer, you do not need this action as its own step. That version of that action handles all caching internally, and better.

Usage

uses: freckle/stack-cache-action@v2

Behavior

1. Restores/saves ~/.stack and all .stack-work directories, as determined by the location of .cabal and package.yaml files

2. Includes a hash of all source files in the cache key, so a new cache will be saved even if the dependencies haven't changed. This prevents re-compilation of un-changed modules in later builds.

3. Falls back to same resolver/dependencies, then same resolver (but no further)

Inputs

• stack-yaml: Path to your stack.yaml file
• working-directory: Useful in monorepositories
• prefix: A prefix to include on keys; useful for cache busting or versioning

Outputs

• cache-hit: indicates a full cache hit on the primary key

Further Reading

See https://tech.freckle.com/2021/05/18/haskell-on-actions/ for a short tutorial.

Acknowledgements

The idea and initial repository skeleton was taken from gha-yarn-cache.

---

LICENSE | CHANGELOG