corca-ai / local-cache

This action allows caching dependencies and build outputs to improve workflow execution time on self hosted machine.

Local Cache action

This action allows caching dependencies and build outputs to improve workflow execution time on self hosted machine. Artifacts are cached in the /home/ubuntu/.cache by default.

What's New

v2

• Caches that have not been accessed over 7 days are cleaned up automatically at post action stage by clean-key.

See the v1 README.md for older updates.

Usage

Pre-requisites

Create a workflow .yml file in your repository's .github/workflows directory.

Inputs

path

Required

A directory to save and restore cache.

key

Required

An explicit key for a cache.

base

Optional

A base directory to save and restore cache.

Default: /home/ubuntu/.cache

clean-key

Optional

If set, caches that have not been accessed over 7 days are cleaned up automatically at post action stage by clean-key.

Outputs

cache-hit

Cache hit or not

Example cache workflow

Restoring and saving cache using a single action

name: Caching Primes

on: push

jobs:
  build:
    runs-on: [self-hosted]

    steps:
      - uses: actions/checkout@v3

      - name: Cache dependencies
        id: cache
        uses: corca-ai/local-cache@v2
        with:
          path: path/to/dependencies
          key: ${{ hashFiles('**/lockfiles') }}

      - name: Install dependencies
        if: steps.cache.outputs.cache-hit != 'true'
        run: /install.sh

      - name: Use dependencies
        run: /run.sh

Cache Limits

Cache limits are defined by the disk space of self-hosted runners. Caches that have not been accessed over 7 days can be cleaned up at post action stage by clean-key, but if you still run out of disk space, you need to manage runners by increasing disk capacity or removing cache on your own.

local-cache's Issues

Support for restore-keys

Any support for the restore-keys from actions/cache@v3 for cache fallback?

      - uses: actions/cache@v3
        name: Composer Cache
        with:
          path: ${{ steps.composer-cache-dir.outputs.dir }}
          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
          restore-keys: |
            ${{ runner.os }}-composer-

Error: Unable to locate executable file: mkdir

I got an error when trying this action. Here is the message:
Error: Unable to locate executable file: mkdir. Please verify either the file path exists or the file can be found within a directory specified by the PATH environment variable. Also verify the file has a valid extension for an executable file.
I can run "mkdir" directly as a step in the script so I'm not sure what causes it. Is there any other requirement for this action?

Github Action deprecation: node.js update to 20

Hi, i noticed Github is deprecating node.js 16 in favor of 20 by june, see this Github notice, and flagged this.

Would it be possible and easy for you to publish a new version of this action with the updated Node.js by then? I am afraid i am a newbie and i don't know how easy it is