docs: modernize dependency update commands#2864
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughRenamed the Node section to "Node Dependencies", changed working-directory guidance to the directory containing Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
Review: docs: modernize dependency update commandsGood improvement overall — replacing the stale Two minor issues to address:
Everything else looks solid. |
Greptile SummaryThis PR modernizes Key changes:
Issues found:
Confidence Score: 4/5Safe to merge after the Documentation-only PR that is largely correct and a net improvement. One concrete technical inaccuracy ( docs/oss/misc/updating-dependencies.md — specifically line 50 ( Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Start: Update Node Dependencies] --> B{Which package manager?}
B -->|pnpm| C[pnpm outdated]
B -->|npm| D[npm outdated]
B -->|yarn| E[yarn outdated]
C --> F{Update strategy?}
D --> F
E --> F
F -->|Option 1: ncu| G[pnpm dlx npm-check-updates -u -a]
F -->|Option 2: native| H[pnpm up --latest]
G --> I[pnpm install]
H --> J[Done]
I --> J
J --> K[Verify: hot-reload dev server + Rails server]
|
There was a problem hiding this comment.
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 `@docs/oss/misc/updating-dependencies.md`:
- Around line 66-67: The current equivalence is misleading: clarify that `npm
update` respects existing semver ranges and will not change package.json,
whereas `pnpm up --latest` (and `npm install <package>@latest` / `npm i
<package>@latest`) installs the newest versions and updates package.json; update
the sentence to explicitly map `npm update` to the behavior that respects ranges
and map `npm install <package>@latest` (or `npm i <package>@latest`) to the
behavior that upgrades to latest and updates package.json, and mention the
behavioral difference relative to `pnpm up --latest`.
🪄 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
Run ID: d3cdd63c-9afc-4f55-a579-d6ef850e4e25
📒 Files selected for processing (1)
docs/oss/misc/updating-dependencies.md
Follow-up review (second commit)The second commit correctly fixed the One remaining issue: The numbered "Install" step in Option 1 (line 34) is still there and is now misleading. Everything else looks good to me. |
Review: docs: modernize dependency update commandsThis is a clean, well-scoped documentation update. The shift from Two minor issues to address:
Minor nit (PR description only, not in merged code): The test plan references an absolute local path |
Address unresolved review feedback and add missing coverage: - Split `pnpm up --latest` into two commands: `pnpm up` (within ranges) and `pnpm up --latest` (ignore ranges), fixing a silent behavioral shift from the old `yarn upgrade` which respected semver ranges - Break dense inline npm/yarn equivalents into scannable lists - Add `yarn upgrade --latest` for the all-packages case - Add bun equivalents throughout (outdated, update, ncu, add) - Add comparison table for upgrade command behavior across package managers - Clarify that `npm update` only touches the lockfile by default - Replace first-person "combinations that I often run" phrasing Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Good documentation update overall — the move from Yarn + One minor accuracy concern worth verifying: bun commands — Everything else looks accurate:
|
## Summary - Stamped `### [16.5.1] - 2026-03-27` with two Pro fixes (PRs #2872, #2768) - Removed the `### [16.5.0.rc.0]` section (was already released as 16.5.0 stable) - Consolidated the 16.5.0 section with full entries (previously just said "no changes from rc.0") - Updated diff links at bottom of file ## Skipped PRs (docs/internal only) #2856, #2860, #2857, #2859, #2864, #2870, #2863, #2868, #2827, #2862, #2850, #2851, #2852, #2831, #2610, #2848 ## Test plan - [ ] Verify CHANGELOG.md formatting and diff links are correct - [ ] Run `rake release` (no args) after merge to publish 16.5.1 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk: changes are limited to `CHANGELOG.md` release notes and version/compare links with no runtime code modifications. > > **Overview** > Documents the `16.5.1` release by adding a new section under *Unreleased* with two **[Pro]** fixes (missing packaged rake tasks and avoiding duplicated bundles during remote renderer asset uploads). > > Cleans up the `16.5.0` entry by removing the `16.5.0.rc.0` section and updating the compare-link footer so `unreleased` now starts from `v16.5.1` and `16.5.0` compares from `v16.4.0`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 9a6b224. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated changelog to document version 16.5.1 release with consolidated version history and updated comparison links. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…olve-2835 * origin/main: Bump version to 16.5.1 Update CHANGELOG.md for 16.5.1 (#2873) fix: include lib/tasks/ in pro gem so rake tasks are available (#2872) docs: clarify how React on Rails compares to alternatives (#2856) docs: fix published setup guidance gaps (#2860) docs: refresh setup and runtime guidance (#2857) docs: refresh pro upgrade examples (#2859) docs: modernize dependency update commands (#2864) Update spec/dummy Gemfile.lock for async >= 2.29 (#2870) # Conflicts: # CHANGELOG.md
…olve-2849 * origin/main: Bump version to 16.5.1 Update CHANGELOG.md for 16.5.1 (#2873) fix: include lib/tasks/ in pro gem so rake tasks are available (#2872) docs: clarify how React on Rails compares to alternatives (#2856) docs: fix published setup guidance gaps (#2860) docs: refresh setup and runtime guidance (#2857) docs: refresh pro upgrade examples (#2859) docs: modernize dependency update commands (#2864) Update spec/dummy Gemfile.lock for async >= 2.29 (#2870) # Conflicts: # CHANGELOG.md
…olve-2828 * origin/main: Bump version to 16.5.1 Update CHANGELOG.md for 16.5.1 (#2873) fix: include lib/tasks/ in pro gem so rake tasks are available (#2872) docs: clarify how React on Rails compares to alternatives (#2856) docs: fix published setup guidance gaps (#2860) docs: refresh setup and runtime guidance (#2857) docs: refresh pro upgrade examples (#2859) docs: modernize dependency update commands (#2864) Update spec/dummy Gemfile.lock for async >= 2.29 (#2870) # Conflicts: # CHANGELOG.md
…olve-2834 * origin/main: Bump version to 16.5.1 Update CHANGELOG.md for 16.5.1 (#2873) fix: include lib/tasks/ in pro gem so rake tasks are available (#2872) docs: clarify how React on Rails compares to alternatives (#2856) docs: fix published setup guidance gaps (#2860) docs: refresh setup and runtime guidance (#2857) docs: refresh pro upgrade examples (#2859) docs: modernize dependency update commands (#2864) Update spec/dummy Gemfile.lock for async >= 2.29 (#2870) # Conflicts: # CHANGELOG.md
…olve-2833 * origin/main: Bump version to 16.5.1 Update CHANGELOG.md for 16.5.1 (#2873) fix: include lib/tasks/ in pro gem so rake tasks are available (#2872) docs: clarify how React on Rails compares to alternatives (#2856) docs: fix published setup guidance gaps (#2860) docs: refresh setup and runtime guidance (#2857) docs: refresh pro upgrade examples (#2859) docs: modernize dependency update commands (#2864) Update spec/dummy Gemfile.lock for async >= 2.29 (#2870) # Conflicts: # CHANGELOG.md
…olve-2661 * origin/main: Clarify streaming narrative in RSC docs (#2813) (#2814) Bump version to 16.5.1 Update CHANGELOG.md for 16.5.1 (#2873) fix: include lib/tasks/ in pro gem so rake tasks are available (#2872) docs: clarify how React on Rails compares to alternatives (#2856) docs: fix published setup guidance gaps (#2860) docs: refresh setup and runtime guidance (#2857) docs: refresh pro upgrade examples (#2859) docs: modernize dependency update commands (#2864) Update spec/dummy Gemfile.lock for async >= 2.29 (#2870) # Conflicts: # docs/oss/migrating/rsc-data-fetching.md
Modernize the dependency-updating guide (`docs/oss/misc/updating-dependencies.md`) for the new reactonrails.com docs site. - Replace stale `client/` + Yarn-only commands with root-level, pnpm-first guidance - Add equivalents for all four package managers (npm, yarn, pnpm, bun) throughout - Split `pnpm up` vs `pnpm up --latest` to preserve the original within-range update behavior alongside the aggressive latest-version option - Add comparison table for upgrade command behavior across package managers - Remove redundant "Install npm-check-updates" step (pnpm dlx/npx handle it) - Clarify that `npm update` only touches the lockfile by default Co-Authored-By: Justin Gordon <justin@shakacode.com> Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
## Summary - Stamped `### [16.5.1] - 2026-03-27` with two Pro fixes (PRs #2872, #2768) - Removed the `### [16.5.0.rc.0]` section (was already released as 16.5.0 stable) - Consolidated the 16.5.0 section with full entries (previously just said "no changes from rc.0") - Updated diff links at bottom of file ## Skipped PRs (docs/internal only) #2856, #2860, #2857, #2859, #2864, #2870, #2863, #2868, #2827, #2862, #2850, #2851, #2852, #2831, #2610, #2848 ## Test plan - [ ] Verify CHANGELOG.md formatting and diff links are correct - [ ] Run `rake release` (no args) after merge to publish 16.5.1 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk: changes are limited to `CHANGELOG.md` release notes and version/compare links with no runtime code modifications. > > **Overview** > Documents the `16.5.1` release by adding a new section under *Unreleased* with two **[Pro]** fixes (missing packaged rake tasks and avoiding duplicated bundles during remote renderer asset uploads). > > Cleans up the `16.5.0` entry by removing the `16.5.0.rc.0` section and updating the compare-link footer so `unreleased` now starts from `v16.5.1` and `16.5.0` compares from `v16.4.0`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 9a6b224. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated changelog to document version 16.5.1 release with consolidated version history and updated comparison links. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Summary
Refresh the dependency-updating guide so it matches current React on Rails app layout and package-manager guidance.
Changes in this PR:
client/+ Yarn-only commands with root-level package-manager guidancepnpmas the primary example, matching current project standardsWhy
The published page is still an active contributor-facing guide, but it assumes JavaScript dependencies live under
client/and that every app uses Yarn. Current React on Rails apps usually keeppackage.jsonat the app root, and this repo standardizes onpnpm.Test plan
/Users/justin/codex/react_on_rails/node_modules/.bin/prettier --check docs/oss/misc/updating-dependencies.mdgit diff --checklychee --offline --no-progress --format compact docs/oss/misc/updating-dependencies.mdNote
Low Risk
Low risk documentation-only changes; updates command examples and guidance without affecting runtime code or dependencies.
Overview
Updates
docs/oss/misc/updating-dependencies.mdto modernize Node dependency instructions: switches from Yarn +client/-directory examples to rootpackage.jsonguidance withpnpmas the primary command set.Adds explicit equivalent commands/notes for
npmandyarn, includingnpm-check-updatesusage,pnpm up --latestsemantics vsnpm update, and updated dev-dependency install examples.Written by Cursor Bugbot for commit e264e39. This will update automatically on new commits. Configure here.
Summary by CodeRabbit