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

[BlackHole1]

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.

[coderabbitai]

📝 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

• X
• Mastodon
• Reddit
• LinkedIn

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

[qodo-code-review]

PR Summary by Qodo

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

📝 Documentation 🕐 Less than 10 minutes

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]

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!

[zkochan]

make the changes suggested by coderabbit

[coderabbitai]

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!