feat: store caching by jrmajor · Pull Request #188 · pnpm/action-setup

jrmajor · 2025-11-02T11:52:50Z

pnpm can install Node runtime as a dependency, but actions/setup-node is still needed to cache the pnpm store (as currently suggested in the readme). Alternative is to add something like this to your workflow:

- name: Get pnpm store directory path
  id: pnpm-cache-dir
  run: echo "dir=$(pnpm store path --silent)" >> $GITHUB_OUTPUT

- name: Cache pnpm dependencies
  uses: actions/cache@v4
  with:
    path: ${{ steps.pnpm-cache-dir.outputs.dir }}
    key: pnpm-${{ hashFiles('pnpm-lock.yaml') }}
    restore-keys: pnpm-

With this PR, the same can be accomplished simply by setting cache: true in setup pnpm action:

- name: Setup pnpm
  uses: pnpm/action-setup@v4
  with:
    cache: true

The implementation is based on actions/setup-node.

Closes #70, closes #80, closes #82, closes #152, closes #173.

Once stable, this could be enabled by default, although I think it would require a major version bump.

oBusk · 2025-11-02T12:38:45Z

Would also close #185

jrmajor · 2025-11-03T11:27:43Z

Thanks @oBusk, linked that issue too.

jrmajor · 2025-11-03T11:29:22Z

If you would like to test this in your workflows, you can use the hash of the latest commit from this branch as a version:

- name: Setup pnpm
  # https://github.com/pnpm/action-setup/pull/188
  uses: pnpm/action-setup@0bc9da32cd356746083d9e2b8848bad8b974c72c
  with:
    cache: true

* no semicolons * no star imports * import order

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

zkochan

Looks good except the cache_dependency_path setting, which looks confusing to me. Shouldn't the name somehow indicate that this is a file used during the cache key hash calculation?

zkochan · 2025-12-07T00:43:22Z

README.md

+
+**Optional** (_type:_ `boolean`, _default:_ `false`) Whether to cache the pnpm store directory.
+
+### `cache_dependency_path`


I feel like this setting name is confusing.

This is what it's called in actions/setup-node. I don't love it either, but couldn't come up with anything better. I'm happy to rename it if anyone has a better suggestion.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

jrmajor · 2025-12-23T13:48:04Z

Thanks for reviewing this! Looking forward to seeing this released soon.

* add pnpm store caching * style: format * no semicolons * no star imports * import order * style: no star imports --------- Co-authored-by: khai96_ <hvksmr1996@gmail.com>

@zkochan

* Fix multiline run_install example in README.md (pnpm#167) * Remove --frozen-lockfile from examples (pnpm#171) * feat: support installation from custom NPM registry (pnpm#179) copy .npmrc from GitHub workspace if it exists so that PNPM respects custom registry configurations when self-installing * Update README.md (pnpm#175) fix the string run_install example * Remove unused `@types/node-fetch` dependency (pnpm#186) * Clarify that package_json_file is relative to GITHUB_WORKSPACE (pnpm#184) * Clarify that package_json_file is relative to GITHUB_WORKSPACE Clarify the description for package_json_file parameter to specify that the path must be relative to the repository root. * Apply suggestion from @zkochan --------- Co-authored-by: Zoltan Kochan <z@kochan.io> * feat: store caching (pnpm#188) * add pnpm store caching * style: format * no semicolons * no star imports * import order * style: no star imports --------- Co-authored-by: khai96_ <hvksmr1996@gmail.com> * refactor: remove star imports (pnpm#196) * fix(ci): exclude macos (pnpm#197) * ci: pin github actions (pnpm#199) * fix: regenerate lockfile to match package.json overrides * fix(security): override fast-xml-parser to >=5.3.4 Resolves GHSA-37qj-frw5-hhjh (RangeError DoS via numeric entities) in transitive dependency @actions/cache > @azure/storage-blob > @azure/core-xml > fast-xml-parser. * fix: resolve lint, build, and security audit failures - Fix prefer-const lint error in cache-restore/run.ts - Override undici to >=6.23.0 (GHSA-g9mf-h72j-4rw9) - Rebuild dist to match source changes * fix(ci): exclude dist from CodeQL analysis dist/index.js is generated by ncc bundling — CodeQL flags dependency code as security issues. Ignore the dist directory since it's not source code. --------- Co-authored-by: Matthias <matthias.dailey@gmail.com> Co-authored-by: Adrian Riedel <Eynorey@users.noreply.github.com> Co-authored-by: Roman Usherenko <roman.usherenko@gmail.com> Co-authored-by: silverwind <me@silverwind.io> Co-authored-by: Chris Martin <ch.martin@gmail.com> Co-authored-by: Zoltan Kochan <z@kochan.io> Co-authored-by: Jeremiasz Major <jrh.mjr@gmail.com> Co-authored-by: khai96_ <hvksmr1996@gmail.com> Co-authored-by: Boosted-Bonobo <boostedbonobo1@outlook.com>

add pnpm store caching

0bc9da3

jrmajor mentioned this pull request Nov 2, 2025

feat: install Node.js runtime as a dependency pnpm/pnpm#9755

Merged

oBusk mentioned this pull request Nov 2, 2025

Prune as the post action is not useful #185

Open

oBusk mentioned this pull request Nov 2, 2025

fix: prune after installing #187

Closed

jrmajor mentioned this pull request Nov 3, 2025

Node.js caching like actions/setup-node #70

Closed

KSXGitHub added 3 commits December 6, 2025 11:09

style: format

f6cc97e

* no semicolons * no star imports * import order

style: no star imports

2502eaa

chore(git): merge from master

8aea7c7

KSXGitHub approved these changes Dec 6, 2025

View reviewed changes

KSXGitHub requested review from Copilot and zkochan December 6, 2025 04:23

Copilot started reviewing on behalf of KSXGitHub December 6, 2025 04:24 View session

KSXGitHub changed the title ~~Add pnpm store caching~~ feat: store caching Dec 6, 2025

Copilot AI reviewed Dec 6, 2025

View reviewed changes

zkochan requested a review from Copilot December 7, 2025 00:36

Copilot started reviewing on behalf of zkochan December 7, 2025 00:37 View session

zkochan reviewed Dec 7, 2025

View reviewed changes

Copilot AI reviewed Dec 7, 2025

View reviewed changes

zkochan approved these changes Dec 7, 2025

View reviewed changes

zkochan merged commit e94b270 into pnpm:master Dec 7, 2025
37 of 39 checks passed

Mmx233 mentioned this pull request Dec 14, 2025

Invalid action input 'cache' #198

Open

jrmajor deleted the cache branch December 25, 2025 19:25

WolfSoko mentioned this pull request Jan 7, 2026

Version with cache: true not released #201

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: store caching#188

feat: store caching#188
zkochan merged 4 commits intopnpm:masterfrom
jrmajor:cache

jrmajor commented Nov 2, 2025 •

edited by KSXGitHub

Loading

Uh oh!

oBusk commented Nov 2, 2025

Uh oh!

jrmajor commented Nov 3, 2025

Uh oh!

jrmajor commented Nov 3, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

zkochan left a comment •

edited

Loading

Uh oh!

zkochan Dec 7, 2025

Uh oh!

jrmajor Dec 7, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

jrmajor commented Dec 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants


		Optional (_type:_ `boolean`, _default:_ `false`) Whether to cache the pnpm store directory.

		### `cache_dependency_path`

Uh oh!

Conversation

jrmajor commented Nov 2, 2025 • edited by KSXGitHub Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oBusk commented Nov 2, 2025

Uh oh!

jrmajor commented Nov 3, 2025

Uh oh!

jrmajor commented Nov 3, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

zkochan left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zkochan Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

jrmajor Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jrmajor commented Dec 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jrmajor commented Nov 2, 2025 •

edited by KSXGitHub

Loading

zkochan left a comment •

edited

Loading