Skip to content

docs: Update version to include devEngines.packageManager.version option#244

Open
djmurphy32 wants to merge 2 commits intopnpm:masterfrom
djmurphy32:update-readme
Open

docs: Update version to include devEngines.packageManager.version option#244
djmurphy32 wants to merge 2 commits intopnpm:masterfrom
djmurphy32:update-readme

Conversation

@djmurphy32
Copy link
Copy Markdown

@djmurphy32 djmurphy32 commented May 3, 2026

Summary by CodeRabbit

  • Documentation
    • Clarified that the version input is optional not only when a package manager is declared, but also when the devEngines package manager is set to "pnpm" and a package manager version is present in package.json. Updated linked reference text accordingly.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 3, 2026

📝 Walkthrough

Walkthrough

The PR updates README.md to clarify that the version input is optional not only when package.json contains a packageManager field, but also when devEngines.packageManager.name === "pnpm" and devEngines.packageManager.version is present in package.json. (48 words)

Changes

Version Input Documentation Clarification

Layer / File(s) Summary
Documentation Update
README.md
Clarifies version input is optional when packageManager exists in package.json or when devEngines.packageManager.name === "pnpm" and devEngines.packageManager.version is present.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A README hop, a clearer trail,
Two checks now told in gentle detail.
PNPM or packageManager shows the way,
The version can rest—no need to say. ✨

🚥 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.
Title check ✅ Passed The title accurately describes the main change: updating README.md documentation to include devEngines.packageManager.version as an option for version selection.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 15: Update the README sentence to reflect that the devEngines condition
requires both devEngines.packageManager.name set to "pnpm" and
devEngines.packageManager.version (or a packageManager field) — i.e., change the
phrasing to explicitly require devEngines.packageManager.name: "pnpm" plus
devEngines.packageManager.version rather than implying the version alone is
sufficient.
🪄 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: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: b88e13bc-039d-4143-8abd-c37a83f15b47

📥 Commits

Reviewing files that changed from the base of the PR and between 8912a91 and 81e3dad.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated
@djmurphy32 djmurphy32 changed the title README.md: Update version to include devEngines.packageManager.version option docs: Update version to include devEngines.packageManager.version option May 4, 2026
@Mister-Hope
Copy link
Copy Markdown

Mister-Hope commented May 8, 2026

I personally think this is not the actual behavior, we have issues report in #150 #225 and #227, and my github workflow fails when prefering devEngines.packageManager

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