Skip to content

Example for restore-only cache in documentation #696

Merged
HarithaVattikuti merged 7 commits into
actions:mainfrom
aparnajyothi-y:restore--only--cache-example-update
Dec 18, 2025
Merged

Example for restore-only cache in documentation #696
HarithaVattikuti merged 7 commits into
actions:mainfrom
aparnajyothi-y:restore--only--cache-example-update

Conversation

@aparnajyothi-y

@aparnajyothi-y aparnajyothi-y commented Dec 12, 2025

Copy link
Copy Markdown
Contributor

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 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:
#316 & #497

Check list:

  • [ X] Mark if documentation changes are required.

@aparnajyothi-y aparnajyothi-y requested a review from a team as a code owner December 12, 2025 14:41
Copilot AI review requested due to automatic review settings December 12, 2025 14:41

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds documentation demonstrating how to achieve restore-only caching with setup-node using the actions/cache/restore action. The update addresses community requests for a restore-only flag by documenting an alternative approach using existing actions/cache functionality.

Key changes:

  • Added a "Restore-Only Cache" section with a complete workflow example
  • Demonstrates how to manually restore Go caches without automatic saving
  • Includes cross-platform support for Linux, macOS, and Windows

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@HarithaVattikuti HarithaVattikuti merged commit 4aaadf4 into actions:main Dec 18, 2025
3 checks passed
hoodnoah added a commit to hoodnoah/certmanager-porkbun-webhook that referenced this pull request Jun 10, 2026
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [actions/setup-go](https://github.com/actions/setup-go) | action | major | `v5` → `v6` |

---

### Release Notes

<details>
<summary>actions/setup-go (actions/setup-go)</summary>

### [`v6.4.0`](https://github.com/actions/setup-go/releases/tag/v6.4.0)

[Compare Source](actions/setup-go@v6.3.0...v6.4.0)

##### What's Changed

##### Enhancement

- Add go-download-base-url input for custom Go distributions by [@&#8203;gdams](https://github.com/gdams) in [#&#8203;721](actions/setup-go#721)

##### Dependency update

- Upgrade minimatch from 3.1.2 to 3.1.5 by [@&#8203;dependabot](https://github.com/dependabot) in [#&#8203;727](actions/setup-go#727)

##### Documentation update

- Rearrange README.md, add advanced-usage.md by [@&#8203;priyagupta108](https://github.com/priyagupta108) in [#&#8203;724](actions/setup-go#724)
- Fix Microsoft build of Go link by [@&#8203;gdams](https://github.com/gdams) in [#&#8203;734](actions/setup-go#734)

##### New Contributors

- [@&#8203;gdams](https://github.com/gdams) made their first contribution in [#&#8203;721](actions/setup-go#721)

**Full Changelog**: <actions/setup-go@v6...v6.4.0>

### [`v6.3.0`](https://github.com/actions/setup-go/releases/tag/v6.3.0)

[Compare Source](actions/setup-go@v6.2.0...v6.3.0)

##### What's Changed

- Update default Go module caching to use go.mod by [@&#8203;priyagupta108](https://github.com/priyagupta108) in [#&#8203;705](actions/setup-go#705)
- Fix golang download url to go.dev by [@&#8203;178inaba](https://github.com/178inaba) in [#&#8203;469](actions/setup-go#469)

**Full Changelog**: <actions/setup-go@v6...v6.3.0>

### [`v6.2.0`](https://github.com/actions/setup-go/releases/tag/v6.2.0)

[Compare Source](actions/setup-go@v6.1.0...v6.2.0)

##### What's Changed

##### Enhancements

- Example for restore-only cache in documentation  by [@&#8203;aparnajyothi-y](https://github.com/aparnajyothi-y) in [#&#8203;696](actions/setup-go#696)
- Update Node.js version in action.yml by [@&#8203;ccoVeille](https://github.com/ccoVeille) in [#&#8203;691](actions/setup-go#691)
- Documentation update of actions/checkout by [@&#8203;deining](https://github.com/deining) in [#&#8203;683](actions/setup-go#683)

##### Dependency updates

- Upgrade js-yaml from 3.14.1 to 3.14.2 by [@&#8203;dependabot](https://github.com/dependabot) in [#&#8203;682](actions/setup-go#682)
- Upgrade [@&#8203;actions/cache](https://github.com/actions/cache) to v5 by [@&#8203;salmanmkc](https://github.com/salmanmkc) in [#&#8203;695](actions/setup-go#695)
- Upgrade actions/checkout from 5 to 6 by [@&#8203;dependabot](https://github.com/dependabot) in [#&#8203;686](actions/setup-go#686)
- Upgrade qs from 6.14.0 to 6.14.1 by [@&#8203;dependabot](https://github.com/dependabot) in [#&#8203;703](actions/setup-go#703)

##### New Contributors

- [@&#8203;ccoVeille](https://github.com/ccoVeille) made their first contribution in [#&#8203;691](actions/setup-go#691)
- [@&#8203;deining](https://github.com/deining) made their first contribution in [#&#8203;683](actions/setup-go#683)

**Full Changelog**: <actions/setup-go@v6...v6.2.0>

### [`v6.1.0`](https://github.com/actions/setup-go/releases/tag/v6.1.0)

[Compare Source](actions/setup-go@v6...v6.1.0)

##### What's Changed

##### Enhancements

- Fall back to downloading from go.dev/dl instead of storage.googleapis.com/golang by [@&#8203;nicholasngai](https://github.com/nicholasngai) in [#&#8203;665](actions/setup-go#665)
- Add support for .tool-versions file and update workflow by [@&#8203;priya-kinthali](https://github.com/priya-kinthali) in [#&#8203;673](actions/setup-go#673)
- Add comprehensive breaking changes documentation for v6 by [@&#8203;mahabaleshwars](https://github.com/mahabaleshwars) in [#&#8203;674](actions/setup-go#674)

##### Dependency updates

- Upgrade eslint-config-prettier from 10.0.1 to 10.1.8 and document breaking changes in v6 by [@&#8203;dependabot](https://github.com/dependabot) in [#&#8203;617](actions/setup-go#617)
- Upgrade actions/publish-action from 0.3.0 to 0.4.0 by [@&#8203;dependabot](https://github.com/dependabot) in [#&#8203;641](actions/setup-go#641)
- Upgrade semver and [@&#8203;types/semver](https://github.com/types/semver) by [@&#8203;dependabot](https://github.com/dependabot) in [#&#8203;652](actions/setup-go#652)

##### New Contributors

- [@&#8203;nicholasngai](https://github.com/nicholasngai) made their first contribution in [#&#8203;665](actions/setup-go#665)
- [@&#8203;priya-kinthali](https://github.com/priya-kinthali) made their first contribution in [#&#8203;673](actions/setup-go#673)
- [@&#8203;mahabaleshwars](https://github.com/mahabaleshwars) made their first contribution in [#&#8203;674](actions/setup-go#674)

**Full Changelog**: <actions/setup-go@v6...v6.1.0>

### [`v6.0.0`](https://github.com/actions/setup-go/releases/tag/v6.0.0)

[Compare Source](actions/setup-go@v6...v6)

##### What's Changed

##### Breaking Changes

- Improve toolchain handling to ensure more reliable and consistent toolchain selection and management by [@&#8203;matthewhughes934](https://github.com/matthewhughes934) in [#&#8203;460](actions/setup-go#460)
- Upgrade Nodejs runtime from node20 to node 24 by [@&#8203;salmanmkc](https://github.com/salmanmkc) in [#&#8203;624](actions/setup-go#624)

Make sure your runner is on version v2.327.1 or later to ensure compatibility with this release. [See Release Notes](https://github.com/actions/runner/releases/tag/v2.327.1)

##### Dependency Upgrades

- Upgrade [@&#8203;types/jest](https://github.com/types/jest) from 29.5.12 to 29.5.14 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;589](actions/setup-go#589)
- Upgrade [@&#8203;actions/tool-cache](https://github.com/actions/tool-cache) from 2.0.1 to 2.0.2 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;591](actions/setup-go#591)
- Upgrade [@&#8203;typescript-eslint/parser](https://github.com/typescript-eslint/parser) from 8.31.1 to 8.35.1 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;590](actions/setup-go#590)
- Upgrade undici from 5.28.5 to 5.29.0 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;594](actions/setup-go#594)
- Upgrade typescript from 5.4.2 to 5.8.3 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;538](actions/setup-go#538)
- Upgrade eslint-plugin-jest from 28.11.0 to 29.0.1 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;603](actions/setup-go#603)
- Upgrade `form-data` to bring in fix for critical vulnerability by [@&#8203;matthewhughes934](https://github.com/matthewhughes934) in [#&#8203;618](actions/setup-go#618)
- Upgrade actions/checkout from 4 to 5 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;631](actions/setup-go#631)

##### New Contributors

- [@&#8203;matthewhughes934](https://github.com/matthewhughes934) made their first contribution in [#&#8203;618](actions/setup-go#618)
- [@&#8203;salmanmkc](https://github.com/salmanmkc) made their first contribution in [#&#8203;624](actions/setup-go#624)

**Full Changelog**: <actions/setup-go@v5...v6.0.0>

### [`v6`](actions/setup-go@v5.6.0...v6)

[Compare Source](actions/setup-go@v5.6.0...v6)

</details>

---

### Configuration

📅 **Schedule**: (UTC)

- Branch creation
  - At any time (no schedule defined)
- Automerge
  - At any time (no schedule defined)

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Mend Renovate](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My4yMTcuMSIsInVwZGF0ZWRJblZlciI6IjQzLjIxNy4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

Co-authored-by: hoodn <hood.noah@gmail.com>
Reviewed-on: https://gitea.k3s.noah-hood.io/hoodn/certmanager-porkbun-webhook/pulls/7
Co-authored-by: renovate-bot <renovate-bot@example.local>
Co-committed-by: renovate-bot <renovate-bot@example.local>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants