Add example for restore-only cache in documentation #1419

aparnajyothi-y · 2025-10-21T10:43:59Z

Description:
This PR adds documentation and an example workflow demonstrating how to achieve restore-only caching with setup-node using the actions/cache.
The update is based on community feedback from #663 (“Add option to restore cache only”), which proposed adding a restore-only flag to the action.
Instead of introducing new functionality, this documentation clarifies how users can already achieve this behavior using actions/cache.
Related issue:
#663

Check list:

[ X] Mark if documentation changes are required.

Copilot

Pull Request Overview

This PR adds documentation demonstrating how to achieve restore-only caching behavior with setup-node by using the actions/cache action directly. This addresses community feedback requesting a restore-only flag without introducing new functionality, instead showing users how to accomplish this with existing tools.

Key Changes:

Added a "Restore-Only Cache" section with a complete workflow example
Included explanatory note about the benefits of restore-only caching

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

docs/advanced-usage.md

Kas-tle · 2025-11-12T06:56:45Z

Not sure why this was merged as this example will pretty much always fail. The key ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} does not match how this action formats its cache keys. Currently, they are formatted as:

node-cache-${{ runner.os }}-RUNNER_ARCH-PACKAGE_MANAGER-${{ hashFiles('**/yarn.lock') }}

Note that runner architecture and package manager must be specified manually as the latter is not provided as action context, and the former, though provided as ${{ runner.arch }} returns uppercase letters instead of lowercase (as this action formats architecture).

Furthermore, the provided path will also fail as caches (at least on Linux runners) are usually stored under /home/runner/..., not /home. It is also worth pointing out that other package managers (e.g. yarn) would require an alternate path (e.g. /home/runner/.yarn/berry/cache).

Finally, the base action from actions/cache is not restore only, so the provided example would actually result in the cache being duplicated... actions/cache/restore should be used instead. See https://github.com/actions/cache/tree/main/restore.

@priyagupta108

## Release notes Sourced from actions/setup-node's releases. v6.1.0 What's Changed Enhancement: Remove always-auth configuration handling by @priyagupta108 in actions/setup-node#1436 Dependency updates: Upgrade @actions/cache from 4.0.3 to 4.1.0 by @dependabot[bot] in actions/setup-node#1384 Upgrade actions/checkout from 5 to 6 by @dependabot[bot] in actions/setup-node#1439 Upgrade js-yaml from 3.14.1 to 3.14.2 by @dependabot[bot] in actions/setup-node#1435 Documentation update: Add example for restore-only cache in documentation by @aparnajyothi-y in actions/setup-node#1419 Full Changelog: actions/setup-node@v6...v6.1.0 ## Commits 395ad32 Bump js-yaml from 3.14.1 to 3.14.2 (#1435) a4d2e2b Bump actions/checkout from 5 to 6 (#1439) b9b25d4 Remove always-auth configuration handling from action (#1436) 633bb92 Bump @actions/cache from 4.0.3 to 4.1.0 (#1384) dda4788 Add example for restore-only cache in documentation (#1419) See full diff in compare view ![Dependabot compatibility score](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Issue-ID: CIMAN-33 Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: onap.gh2gerrit <[email protected]> Change-Id: I463988e51413333aa9cba61dff3ddd488312adb1 GitHub-PR: #145 GitHub-Hash: ef74739b14d5c224

[//]: # (dependabot-start) ⚠️ \*\*Dependabot is rebasing this PR\*\* ⚠️ Rebasing might not happen immediately, so don't worry if this takes some time. Note: if you make any changes to this PR yourself, they will take precedence over the rebase. --- [//]: # (dependabot-end) Bumps [actions/setup-node](https://github.com/actions/setup-node) from 6.0.0 to 6.1.0. Release notes *Sourced from [actions/setup-node's releases](https://github.com/actions/setup-node/releases).* > v6.1.0 > ------ > > What's Changed > -------------- > > ### Enhancement: > > * Remove always-auth configuration handling by [`@priyagupta108`](https://github.com/priyagupta108) in [actions/setup-node#1436](https://redirect.github.com/actions/setup-node/pull/1436) > > ### Dependency updates: > > * Upgrade `@actions/cache` from 4.0.3 to 4.1.0 by [`@dependabot`](https://github.com/dependabot)[bot] in [actions/setup-node#1384](https://redirect.github.com/actions/setup-node/pull/1384) > * Upgrade actions/checkout from 5 to 6 by [`@dependabot`](https://github.com/dependabot)[bot] in [actions/setup-node#1439](https://redirect.github.com/actions/setup-node/pull/1439) > * Upgrade js-yaml from 3.14.1 to 3.14.2 by [`@dependabot`](https://github.com/dependabot)[bot] in [actions/setup-node#1435](https://redirect.github.com/actions/setup-node/pull/1435) > > ### Documentation update: > > * Add example for restore-only cache in documentation by [`@aparnajyothi-y`](https://github.com/aparnajyothi-y) in [actions/setup-node#1419](https://redirect.github.com/actions/setup-node/pull/1419) > > **Full Changelog**: <actions/setup-node@v6...v6.1.0> Commits * [`395ad32`](actions/setup-node@395ad32) Bump js-yaml from 3.14.1 to 3.14.2 ([#1435](https://redirect.github.com/actions/setup-node/issues/1435)) * [`a4d2e2b`](actions/setup-node@a4d2e2b) Bump actions/checkout from 5 to 6 ([#1439](https://redirect.github.com/actions/setup-node/issues/1439)) * [`b9b25d4`](actions/setup-node@b9b25d4) Remove always-auth configuration handling from action ([#1436](https://redirect.github.com/actions/setup-node/issues/1436)) * [`633bb92`](actions/setup-node@633bb92) Bump `@actions/cache` from 4.0.3 to 4.1.0 ([#1384](https://redirect.github.com/actions/setup-node/issues/1384)) * [`dda4788`](actions/setup-node@dda4788) Add example for restore-only cache in documentation ([#1419](https://redirect.github.com/actions/setup-node/issues/1419)) * See full diff in [compare view](actions/setup-node@2028fbc...395ad32) [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility\_score?dependency-name=actions/setup-node&package-manager=github\_actions&previous-version=6.0.0&new-version=6.1.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- Dependabot commands and options You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

aparnajyothi-y and others added 3 commits October 21, 2025 16:04

Update versions.yml

1256cf1

Update versions.yml

1f782e3

doc update

596683a

Copilot AI review requested due to automatic review settings October 21, 2025 10:44

aparnajyothi-y requested a review from a team as a code owner October 21, 2025 10:44

Copilot AI reviewed Oct 21, 2025

View reviewed changes

docs/advanced-usage.md Outdated Show resolved Hide resolved

docs/advanced-usage.md Outdated Show resolved Hide resolved

aparnajyothi-y added 2 commits October 21, 2025 16:18

update

890a8a9

update

34431cc

aparnajyothi-y closed this Oct 21, 2025

aparnajyothi-y reopened this Oct 21, 2025

doc update

93b1fb7

priya-kinthali approved these changes Oct 21, 2025

View reviewed changes

gowridurgad approved these changes Oct 21, 2025

View reviewed changes

Mrquinn4 approved these changes Oct 21, 2025

View reviewed changes

HarithaVattikuti approved these changes Oct 21, 2025

View reviewed changes

HarithaVattikuti merged commit dda4788 into actions:main Oct 21, 2025
3 checks passed

aparnajyothi-y mentioned this pull request Oct 27, 2025

Add option to restore cache only #663

Closed

actions deleted a comment from meroamir99881-hue Dec 4, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add example for restore-only cache in documentation #1419

Add example for restore-only cache in documentation #1419

aparnajyothi-y commented Oct 21, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Kas-tle commented Nov 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Add example for restore-only cache in documentation #1419

Add example for restore-only cache in documentation #1419

Conversation

aparnajyothi-y commented Oct 21, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Kas-tle commented Nov 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants