Skip to content

Feature request: option to update cache #342

Open

Description

@fsimonis

Problem Description
Currently, the cache action either restores an existing cache on cache-hit, or generates a missing cache on cache-miss. It does not update the cache on cache-hit.

This works well for caching static dependencies, but not for caching build artefacts.

Proposed Solution
Add an option allowing the user to enable cache updates.
This should be false by default to retain backwards-compatibility.

uses: actions/cache@v2
with:
  path: ccache
  key: ${{ matrix.CONFIG }}-${{ matrix.CXX }}-${{ matrix.TYPE }}
  update: true   # <~~ explicitly request an update

Motivation
Some programming languages benefit greatly from build caching. C++ in conjunction with ccache is the prime example. Using caching commonly decreases compilation times by at least 70%. Medium-sized projects easily take 20 minutes to compile.
ccache also manages the cache size itself and automatically removes obsolete entries, thus the cache won't explode with continuous updates.

It also saves time and money for both user and provider. The environment will be happy too.

Activity

  1. eine commented on Jun 4, 2020

    @eine

    I'm having this issue when trying to use @actions/cache for reducing update time of the built-in MSYS2 installation on windows-latest virtual environments. The virtual environments are outdated quite fast, and currently 5503.95 MiB need to be downloaded and installed on each job. It takes 8-10 min.

    As commented in msys2/setup-msys2#23, I'm trying to save /var/cache/pacman/pkg/. However, actions/checkout@v2 allows to do it once only. Later executions skip it: https://github.com/eine/setup-msys2/runs/737062486?check_suite_focus=true#step:12:2

    Post job cleanup.
    Cache hit occurred on the primary key msys, not saving cache.
    

    Then, I tried using the npm package: https://www.npmjs.com/package/@actions/cache. Unfortunately, it fails: https://github.com/eine/setup-msys2/runs/738298072?check_suite_focus=true#step:4:116

    ##[error]reserveCache failed: Cache already exists. Scope: refs/heads/tool-cache, Key: msys2-nokey, Version: 000d31344dacf74d63d9e122f85409f68c5697c2aa32c5626452e8301c5d0c66
    

    As an alternative to updating an existing key, it would be feasible to remove it explicitly (ref #340).

  2. davidsbond commented on Jun 18, 2020

    @davidsbond

    This would also be super handy for persisting the test cache when using GitHub Actions in go projects. For example, I could download the latest test cache, run my tests then update the existing cache with the results of the tests in the current run.

    This way, I can have a global test cache across all my workflow runs.

  3. zen0wu commented on Jun 21, 2020

    @zen0wu

    This also applies to things like webpack loader cache, small, have their own key management, needs to be updated each time

  4. Mordil commented on Aug 7, 2020

    @Mordil

    This would be super valuable for monorepo's where each subproject has its own dependencies it wants to cache and build so that upstream projects have faster build times.

    I ran into the expectation that this was already the default behavior - so I wrote #392 under that assumption

  5. potaito commented on Aug 13, 2020

    @potaito

    Is there any workaround for forcing the update of the cache even on a hit? I can't think of any way...
    In my case it would reduce the compilation time from 20 minutes to 3 minutes if I could use ccache for QT/C++.

  6. Vampire commented on Aug 13, 2020

    @Vampire

    Maybe save as ccache-${{ github.run_id }} and restore with restore key ccache-.
    github.run_id is unique id for the workflow run, so every time a new cache is saved.
    When restoring you will never have an exact match but then the ccache- restore key will restore the latest one that started with that string and in the end create a new one with the current state.

  7. potaito commented on Aug 13, 2020

    @potaito

    @Vampire that's brilliant, thanks mate! You are right, forgot about the pattern matching that the cache finding does. Perhaps this is then a non-issue and your solution is the intended way of doing things?

  8. Vampire commented on Aug 13, 2020

    @Vampire

    Nah, that's merely a work-around.
    It will fill up your 5 GiB of cache and then evict things that might not have been evicted if the cache would have been updatable.

  9. HebaruSan commented on Dec 12, 2020

    @HebaruSan

    Duplicate of #171

  10. 58 remaining items

  11. langston-barrett commented on Apr 2, 2025

    @langston-barrett

    For those using the restore/clear/save workaround, here is an updated version.

    It:

    • No longer requires an "extension" to gh (docs)
    • Uses if to skip deletion when it is not necessary
    • Explicitly reuses the key from the restore step in the delete and save steps, avoiding mismatches
    - name: Restore cache
      uses: actions/cache/restore@v4
      id: cache
      # ...
    
    # Other steps go here...
    
    # Delete the old cache on hit to emulate a cache update. See
    # https://github.com/actions/cache/issues/342.
    - name: Delete old cache
      env:
        GH_TOKEN: ${{ github.token }}
      if: steps.cache.outputs.cache-hit
      # Using `--repo` makes it so that this step doesn't require checking out the
      # repo first.
      run: gh cache delete --repo ${{ github.repository }} ${{ steps.cache.outputs.cache-primary-key }}
    
    - name: Save cache
      uses: actions/cache/save@v4
      # Save the cache even if build steps fail.
      if: always()
      with:
        key: ${{ steps.cache.outputs.cache-primary-key }}
        # ...
  12. WestonThayer commented on Sep 30, 2025

    @WestonThayer

    It seems like the restore/clear/save approach has a concurrency / race condition footgun? The error message actions/cache/save gives when you try to rewrite a cache makes me think multiple jobs can fight, like what happens if one job is trying to gh cache delete while another is actively writing to the cache?

    Failed to save: Unable to reserve cache with key KEY, another job may be creating this cache.
    Warning: Cache save failed.
    
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions