docs: Update README to include devEngines.packageManager#273
Conversation
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📜 Recent review details🔇 Additional comments (1)
📝 WalkthroughWalkthroughThe README's documentation was updated to reference ChangesREADME documentation update
Estimated code review effort: 1 (Trivial) | ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
Updates the action’s README to document that pnpm version resolution can also come from devEngines.packageManager in package.json, aligning the docs with functionality added in prior PRs (#211, #256).
Changes:
- Document
devEngines.packageManageras an additional source for pnpm version selection whenversioninput is omitted. - Update
package_json_fileinput description to mentiondevEngines.packageManager. - Update usage guidance text to reference
devEngines.packageManageralongsidepackageManager.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### `package_json_file` | ||
|
|
||
| **Optional** (_type:_ `string`, _default:_ `package.json`) File path to the `package.json`/[`package.yaml`](https://github.com/pnpm/pnpm/pull/1799) to read "packageManager" configuration. | ||
| **Optional** (_type:_ `string`, _default:_ `package.json`) File path to the `package.json`/[`package.yaml`](https://github.com/pnpm/pnpm/pull/1799) to read `packageManager` or `devEngines.packageManager` configuration. |
There was a problem hiding this comment.
Not sure if this is desired. Explicit vs implicit. Nothing wrong with having it.
| ### Install only pnpm without `packageManager` | ||
|
|
||
| This works when the repo either doesn't have a `package.json` or has a `package.json` but it doesn't specify `packageManager`. | ||
| This works when the repo either doesn't have a `package.json` or has a `package.json` but it doesn't specify `packageManager` or `devEngines.packageManager`. |
There was a problem hiding this comment.
As with the above comment, this is a matter of explicit vs implicit. Nothing wrong with this change if it's desired.
| ### Install only pnpm with `packageManager` | ||
|
|
||
| Omit `version` input to use the version in the [`packageManager` field in the `package.json`](https://nodejs.org/api/corepack.html). | ||
| Omit `version` input to use the version in the [`packageManager` or `devEngines.packageManager` field in the `package.json`](https://nodejs.org/api/corepack.html). |
There was a problem hiding this comment.
More explicit vs implicit. Same as above comments.
Support added in #211 and #256
Summary by CodeRabbit