Skip to content

docs(README): point users to the successor pnpm/setup action - #282

Merged
BlackHole1 merged 2 commits into
masterfrom
docs/pnpm-setup-migration
Aug 3, 2026
Merged

BlackHole1 merged 2 commits into
masterfrom
docs/pnpm-setup-migration

Conversation

@BlackHole1

@BlackHole1 BlackHole1 commented Aug 1, 2026 •

Copy link
Copy Markdown
Member

The pnpm setup action has a successor: pnpm/setup installs pnpm v11+ as a self-contained native executable and can install a JavaScript runtime (Node.js, Bun, or Deno) in the same step, replacing actions/setup-node. This README didn't mention it, so users landing here had no pointer to the new action or guidance on moving over.

This adds an important notice at the top pointing to the successor, a "Migrating to pnpm/setup" section with a before/after workflow example and an input/output mapping table (run_install becomes install, snake_case inputs renamed to kebab-case, standalone removed, new runtime and token inputs), and a short mention in the Notes section. Everything else stays intact since pnpm/action-setup remains the way to install pnpm v10 and older.

Summary by CodeRabbit

  • Documentation
    • Updated guidance to recommend pnpm/setup for pnpm v11 and later.
    • Added migration instructions and input/output mappings.
    • Clarified runtime and dependency installation capabilities.
    • Linked the Notes section to new runtime installation information.
    • Improved transition guidance from the superseded setup action.

The pnpm setup action has moved to `pnpm/setup`, which installs
pnpm v11+ as a self-contained native executable and can install a
JavaScript runtime (Node.js, Bun, or Deno) in the same step,
replacing `actions/setup-node`.

Add a notice at the top of the README, a migration section with a
before/after workflow example and an input/output mapping table,
and mention the successor in the Notes section. The rest of the
docs stay intact since `pnpm/action-setup` remains the way to
install pnpm v10 and older.

Signed-off-by: Kevin Cui <bh@bugs.cc>
@BlackHole1
BlackHole1 requested a review from zkochan as a code owner August 1, 2026 14:03
@coderabbitai

coderabbitai Bot commented Aug 1, 2026 •

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

README.md documents pnpm/setup as the replacement for pnpm v11+, provides migration guidance, maps action inputs and outputs, and describes combined pnpm and Node.js installation.

Changes

pnpm setup migration

Layer / File(s) Summary
Deprecation and migration guidance
README.md
The README directs pnpm v11+ users to pnpm/setup, retains guidance for pnpm v10 and older, adds the v2 upgrade warning, and documents workflow, input, and output mappings. It also describes combined pnpm and Node.js installation.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Poem

A rabbit checks the setup trail,
v11 guidance will not fail.
Inputs map and outputs gleam,
pnpm and Node.js share the stream.
Clear migration steps now guide the way.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the README change that directs users to the successor pnpm/setup action.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/pnpm-setup-migration

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

docs(README): add migration guidance to successor pnpm/setup action

📝 Documentation 🕐 Less than 10 minutes

Grey Divider

AI Description

• Add an IMPORTANT notice pointing pnpm v11+ users to pnpm/setup.
• Document a before/after workflow showing pnpm/setup replacing setup-node.
• Provide an input/output mapping table to ease migration from this action.
Diagram

graph TD
  U([User]) --> R["README.md (notice + migration)"] --> W["GitHub Actions workflow"]
  W --> A1["pnpm/action-setup (pnpm<=10)"] --> N1["actions/setup-node"]
  W --> A2["pnpm/setup (pnpm>=11)"]
  A2 -. "replaces" .-> N1
Loading
High-Level Assessment

The following are alternative approaches to this PR:

1. Add deprecation messaging in action metadata/Marketplace
  • ➕ Reaches users who never read the README (Marketplace users, existing workflow users)
  • ➕ Provides a stronger, more visible migration nudge
  • ➖ May be perceived as too aggressive while pnpm<=10 remains supported here
  • ➖ Requires changes outside documentation and potentially more coordination
2. Move migration content to MIGRATION.md and keep README brief
  • ➕ Keeps README shorter while still offering detailed guidance
  • ➕ Allows the migration guide to evolve independently
  • ➖ Users may miss the guide unless prominently linked
  • ➖ Adds another doc entry point to maintain

Recommendation: The PR’s approach (top-of-README notice + explicit before/after workflow + mapping table) is the best default because it meets users at the primary entry point and provides concrete, actionable migration steps. If migration pressure needs to increase later, consider additionally adding Marketplace/action-metadata messaging, but keep that separate from this doc-only change.

Files changed (1) +48 / -1

Documentation (1) +48 / -1
README.mdDocument successor 'pnpm/setup' and provide migration guide +48/-1

Document successor 'pnpm/setup' and provide migration guide

• Adds an IMPORTANT banner pointing pnpm v11+ users to 'pnpm/setup' and clarifying this action remains for pnpm v10 and older. Introduces a migration section with a before/after workflow example and an input/output mapping table (including renamed/removed inputs and new 'runtime'/'token'). Updates Notes to mention 'pnpm/setup' can install pnpm and Node.js together for pnpm v11+.

README.md

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 1-7: Update the README.md callout block by prefixing the blank
separator line after the pnpm v10 guidance with “>”, keeping the entire
multi-paragraph notice within the same blockquote and satisfying markdownlint
MD028.
- Line 237: Update the README sentence to use “set up” as the verb and split the
comma-spliced sentence into separate sentences while preserving the existing
guidance and links.
- Around line 35-38: Update the migration example’s pnpm/setup configuration to
explicitly specify pnpm version 11, or include the required package.json
packageManager upgrade before removing the version input; ensure the “After”
workflow never leaves pnpm unresolved or below v11.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 2fe58497-d91e-42af-8555-6842fadd2a91

📥 Commits

Reviewing files that changed from the base of the PR and between 0ebf471 and 0bc19ea.

📒 Files selected for processing (1)
  • README.md
📜 Review details
⏰ Context from checks skipped due to timeout. (2)
  • GitHub Check: Standalone Windows self-update (PATH regression)
  • GitHub Check: Analyze (javascript-typescript)
🧰 Additional context used
🪛 LanguageTool
README.md

[uncategorized] ~53-~53: The official name of this software platform is spelled with a capital “H”.
Context: ...b token for release lookup; defaults to ${{ github.token }} and rarely needs to be set. |...

(GITHUB)

🪛 markdownlint-cli2 (0.23.1)
README.md

[warning] 7-7: Blank line inside blockquote

(MD028, no-blanks-blockquote)

🔇 Additional comments (2)
README.md (2)

16-23: LGTM!


41-54: LGTM!

Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread README.md Resolved
@zkochan

zkochan commented Aug 2, 2026

Copy link
Copy Markdown
Member

make the changes suggested by coderabbit

Add an explicit version: 11 to the migration example and note when the
input can be omitted, since pnpm/setup requires pnpm v11+ and a repo
migrating from version: 10 may have no packageManager field or one that
pins v10.

Move the v2 upgrade warning below the page title so the two callouts
are no longer adjacent blockquotes (markdownlint MD028), keeping the
successor notice and the legacy warning as separate blocks.

Fix the comma splice and use "set up" as the verb in the Notes
section.

Signed-off-by: Kevin Cui <bh@bugs.cc>

@coderabbitai coderabbitai Bot 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.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
README.md (1)

56-56: 🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win

Remove the token migration row.

This table describes pnpm/setup@v1, but that action version does not declare a token input. Remove the row unless the supported release version adds and documents it.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 56, Remove the `token` row from the `pnpm/setup@v1`
migration table in README.md; do not document this input unless the supported
action version declares and documents it.

Source: MCP tools

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@README.md`:
- Line 56: Remove the `token` row from the `pnpm/setup@v1` migration table in
README.md; do not document this input unless the supported action version
declares and documents it.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: e9ab4180-136f-40d9-b3dd-62efa61c348d

📥 Commits

Reviewing files that changed from the base of the PR and between 0bc19ea and eaee327.

📒 Files selected for processing (1)
  • README.md
📜 Review details
⏰ Context from checks skipped due to timeout. (3)
  • GitHub Check: Smoke (windows / v9.15.5)
  • GitHub Check: Standalone Windows self-update (PATH regression)
  • GitHub Check: Analyze (javascript-typescript)
🧰 Additional context used
🪛 LanguageTool
README.md

[style] ~14-~14: Consider using a different verb for a more formal wording.
Context: ...lease, upgrade to the latest version to fix any issues. ## Migrating to pnpm/setup...

(FIX_RESOLVE)

🔇 Additional comments (4)
README.md (4)

1-7: LGTM!


12-14: LGTM!


16-55: LGTM!


240-240: LGTM!

@BlackHole1
BlackHole1 force-pushed the docs/pnpm-setup-migration branch from b347683 to eaee327 Compare August 3, 2026 02:48
@BlackHole1
BlackHole1 merged commit 6fed91f into master Aug 3, 2026
44 checks passed
@BlackHole1
BlackHole1 deleted the docs/pnpm-setup-migration branch August 3, 2026 02:56
dbmikus pushed a commit to gofixpoint/amika that referenced this pull request Oct 23, 2026
Bumps [pnpm/action-setup](https://github.com/pnpm/action-setup) from 5.0.0 to 6.1.0.

## Release notes

Sourced from pnpm/action-setup's releases.

### v6.1.0

### What's Changed
- feat: support pnpm v12 by `@zkochan` in pnpm/action-setup#288

Full Changelog: pnpm/action-setup@v6.0.10...v6.1.0

### v6.0.10

### What's Changed
- docs(README): point users to the successor pnpm/setup action by `@BlackHole1` in pnpm/action-setup#282
- refactor: introduce restore keys for cache by `@SukkaW` in pnpm/action-setup#280
- ci: use pnpm 11 for `pr-check` by `@jamietanna` in pnpm/action-setup#284
- fix: update pnpm to v11.19.0 by `@jamietanna` in pnpm/action-setup#283
- docs: update README to include devEngines.packageManager by `@nemchik` in pnpm/action-setup#273

### New Contributors
- `@jamietanna` made their first contribution in pnpm/action-setup#284
- `@nemchik` made their first contribution in pnpm/action-setup#273

Full Changelog: pnpm/action-setup@v6...v6.0.10

### v6.0.9

### What's Changed
- fix: update pnpm to v11.7.0 by `@zkochan` in pnpm/action-setup#267

Full Changelog: pnpm/action-setup@v6...v6.0.9

### v6.0.8

### What's Changed
- docs(README): fix `cache_dependency_path` type by `@haines` in pnpm/action-setup#257
- fix: drop patchPnpmEnv so standalone+self-update works on Windows by `@zkochan` in pnpm/action-setup#258
- fix: update pnpm to 11.1.1 by `@mungodewar` in pnpm/action-setup#248

### New Contributors
- `@mungodewar` made their first contribution in pnpm/action-setup#248

Full Changelog: pnpm/action-setup@v6.0.7...v6.0.8

### v6.0.7

### What's Changed
- fix: honor devEngines.packageManager.onFail=error (#252) by `@zkochan` in pnpm/action-setup#254
- fix: restore inputs from state in post by `@haines` in pnpm/action-setup#255
- fix: self-update bootstrap to packageManager-pinned version (#233) by `@zkochan` in pnpm/action-setup#256

### New Contributors
- `@haines` made their first contribution in pnpm/action-setup#255

Full Changelog: pnpm/action-setup@v6.0.6...v6.0.7

... (truncated)

## Commits
- `ea17c68` feat: support pnpm v12 (#288)
- `0977fd9` docs: Update README to include devEngines.packageManager (#273)
- `48261ac` fix: update pnpm to v11.19.0 (#283)
- `75677f7` ci: use pnpm 11 for `pr-check` (#284)
- `769ae71` refactor: introduce restore keys for cache (#280)
- `6fed91f` docs(README): point users to the successor pnpm/setup action (#282)
- `0ebf471` fix: update pnpm to v11.7.0 (#267)
- `0e279bb` fix: update pnpm to 11.1.1 (#248)
- `3e83581` fix: drop patchPnpmEnv so standalone+self-update works on Windows (#258)
- `551b42e` docs(README): fix `cache_dependency_path` type (#257)
- Additional commits viewable in compare view
theinditector pushed a commit to IndicoDataSolutions/pnpm-action-setup that referenced this pull request Oct 28, 2026
* fix: update pnpm to v11.7.0 (pnpm#267)

* fix: update pnpm to v11.7.0

* fix: update bundle

* docs(README): point users to the successor pnpm/setup action (pnpm#282)

* docs(README): point users to the successor pnpm/setup action

The pnpm setup action has moved to `pnpm/setup`, which installs
pnpm v11+ as a self-contained native executable and can install a
JavaScript runtime (Node.js, Bun, or Deno) in the same step,
replacing `actions/setup-node`.

Add a notice at the top of the README, a migration section with a
before/after workflow example and an input/output mapping table,
and mention the successor in the Notes section. The rest of the
docs stay intact since `pnpm/action-setup` remains the way to
install pnpm v10 and older.

Signed-off-by: Kevin Cui <bh@bugs.cc>

* docs(README): address review feedback on migration section

Add an explicit version: 11 to the migration example and note when the
input can be omitted, since pnpm/setup requires pnpm v11+ and a repo
migrating from version: 10 may have no packageManager field or one that
pins v10.

Move the v2 upgrade warning below the page title so the two callouts
are no longer adjacent blockquotes (markdownlint MD028), keeping the
successor notice and the legacy warning as separate blocks.

Fix the comma splice and use "set up" as the verb in the Notes
section.

Signed-off-by: Kevin Cui <bh@bugs.cc>

---------

Signed-off-by: Kevin Cui <bh@bugs.cc>

* refactor: introduce restore keys for cache (pnpm#280)

* ci: use pnpm 11 for `pr-check` (pnpm#284)

Noticed while working on pnpm#283.

* fix: update pnpm to v11.19.0 (pnpm#283)

* fix: update pnpm to v11.19.0

Via `scripts/update-bootstrap.mjs 11.19.0`

Co-authored-by: Claude Sonnet 5 <jamie.tanna+claude-code@mend.io>

* fixup! fix: update pnpm to v11.19.0

As it needs to be rebuilt on Linux.

---------

Co-authored-by: Claude Sonnet 5 <jamie.tanna+claude-code@mend.io>

* docs: Update README to include devEngines.packageManager (pnpm#273)

Support added in pnpm#211 and pnpm#256

* feat: support pnpm v12 (pnpm#288)

* feat: support pnpm v12

Approve the pinned @pnpm/exe install script for npm 12, add pnpm 12 coverage across supported runner platforms, and clarify that action-setup remains supported alongside pnpm/setup.

* refactor: use pnpm 12 native bootstrap

Install the plain pnpm v12 package as the single native bootstrap, remove the legacy @pnpm/exe lockfile and runtime path, and retain the standalone input as a no-op for workflow compatibility.

* fix: keep bootstrap updates on pnpm 12

Handle npm's array-shaped view output and resolve only pnpm 12 distribution tags.

* fix: use native bootstrap only for pnpm 12

Route pnpm 12-only versions and ranges through the plain pnpm native package while preserving the existing Node and @pnpm/exe bootstrap paths for older releases.

* style: remove updater narrative comments

---------

Signed-off-by: Kevin Cui <bh@bugs.cc>
Co-authored-by: Zoltan Kochan <z@kochan.io>
Co-authored-by: Kevin Cui <github@bugs.cc>
Co-authored-by: Sukka <isukkaw@gmail.com>
Co-authored-by: Jamie Tanna <github@jamietanna.co.uk>
Co-authored-by: Jamie Tanna <jamie@jamietanna.co.uk>
Co-authored-by: Claude Sonnet 5 <jamie.tanna+claude-code@mend.io>
Co-authored-by: Eric Nemchik <eric@nemchik.com>
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.

2 participants