feat: Introduced restore-only flag - #1743
Open
gmazzo wants to merge 1 commit into
Open
Conversation
gmazzo
force-pushed
the
restore-only-flag
branch
from
4e5d7b7 to
832f315
Compare
April 1, 2026 20:34
gmazzo
marked this pull request as ready for review
April 1, 2026 20:36
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a restore-only input to the main actions/cache action to support “restore but don’t save” scenarios (e.g., avoid overwriting caches on non-default branches).
Changes:
- Introduces new restore-only input in action metadata and README.
- Adds Inputs.RestoreOnly constant and test utilities support for the new input.
- Updates save implementation and adds a unit test intending to ensure save is skipped when restore-only is set.
Reviewed changes
Copilot reviewed 6 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file| File | Description |
|---|---|
| src/utils/testUtils.ts | Adds test input wiring/cleanup for restore-only. |
| src/saveImpl.ts | Adds restore-only handling in the post-save implementation. |
| src/constants.ts | Introduces Inputs.RestoreOnly. |
| tests/saveImpl.test.ts | Adds a test for restore-only behavior. |
| action.yml | Exposes restore-only as an action input. |
| README.md | Documents the new restore-only option and an example expression. |
| dist/save/index.js | Updates compiled save bundle for the new input/behavior. |
| dist/save-only/index.js | Updates compiled save-only bundle for the new input/behavior. |
| dist/restore/index.js | Updates compiled restore bundle enum to include the new input. |
| dist/restore-only/index.js | Updates compiled restore-only bundle enum to include the new input. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sorry, something went wrong.
Comment thread
src/saveImpl.ts
Comment thread
__tests__/saveImpl.test.ts
Comment thread
action.yml
Outdated
gmazzo
force-pushed
the
restore-only-flag
branch
2 times, most recently
from
b9a2cb5 to
e58227c
Compare
April 1, 2026 21:00
gmazzo
force-pushed
the
restore-only-flag
branch
from
e58227c to
c5d83da
Compare
June 26, 2026 14:59
gmazzo
force-pushed
the
restore-only-flag
branch
from
c5d83da to
ed7b7dd
Compare
June 26, 2026 15:01
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Introduces controlling when to save the cache with a flag.
Description
Introduces a new restore-only flag into the main @actions/cache. If set, the action will download the cache, but it will skip its saving at the post actions phase.
Fixes #1730
Motivation and Context
It's true that we do have the @actions/cache/restore and @actions/cache/save actions, but this change serves a new unsupported use-case: "only feed the cache given a condition".
This use case is a generalisation of the one I'm interesting on to support, which is "only feed the cache at the default branch". A topic you raise at force-deletion-of-caches-overriding-default-cache-eviction-policy. After carefully reviewing the setup options for the action, we concluded there is no straight forward way (currently) to achieve this.
The change will also allow us to align our ad-hocs @actions/cache with the default gradle/actions/setup-gradle's behavior, where its cache-read-only (defaulting to ${{ github.event.repository != null && github.ref_name != github.event.repository.default_branch }}) behaves the same.
Right now, to support our use case, we have been forced to create an internal wrapper composite action that runs @actions/cache/restore or @actions/cache based on this condition.
@actions/cache/save is not fully suitable for the use case, because it does not runs as a post action.
How Has This Been Tested?
A dedicated unit test was added to the saveImpl.test.ts suite.
Test PR in the fork running CI: gmazzo#1
Types of changes
Checklist: