Add upgrade guide for v16.0.x to v16.1.1 #2130
Conversation
Adds comprehensive documentation for upgrading from React on Rails v16.0.x to v16.1.1: - New release notes file: docs/upgrading/release-notes/16.1.0.md - Step-by-step upgrade instructions - New features: doctor rake task, server bundle security options - Generator improvements with modern TypeScript patterns - Deprecations and migration guidance - Common troubleshooting issues - Version compatibility matrix - Updated docs/upgrading/upgrading-react-on-rails.md - Added quick upgrade summary for v16.1.x - Links to detailed release notes Closes #1831 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
WalkthroughDocumentation updates adding comprehensive upgrade guidance from v16.0.x to v16.1.x, including a new release notes file with step-by-step upgrade workflow, new features, deprecations, bug fixes, security enhancements, version compatibility information, and troubleshooting solutions. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ 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.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/upgrading/release-notes/16.1.0.md (1)
188-188: Add language specification to fenced code blocks.Lines 188 and 196 contain fenced code blocks without language identifiers. Per markdown best practices, these should specify the language to enable proper syntax highlighting.
- ``` + ```bash ERROR: You have uncommitted changes - ``` + ```bash- ``` + ```bash # Check versions bundle show shakapacker yarn list shakapacker # or npm ls shakapacker - ``` + ```bashAlso applies to: 196-196
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/upgrading/release-notes/16.1.0.md(1 hunks)docs/upgrading/upgrading-react-on-rails.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*
📄 CodeRabbit inference engine (CLAUDE.md)
ALWAYS ensure files end with a newline character before committing/pushing
Files:
docs/upgrading/release-notes/16.1.0.mddocs/upgrading/upgrading-react-on-rails.md
🧠 Learnings (6)
📓 Common learnings
Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-25T08:05:17.804Z
Learning: Applies to /CHANGELOG.md : Update `/CHANGELOG.md` for user-visible changes (features, bug fixes, breaking changes, deprecations, performance improvements) to the open-source React on Rails gem and npm package
Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-25T08:05:17.804Z
Learning: Applies to /CHANGELOG*.md : Use changelog format: `[PR 1818](https://github.com/shakacode/react_on_rails/pull/1818) by [username](https://github.com/username)` (no hash in PR number)
📚 Learning: 2025-11-25T08:05:17.804Z
Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-25T08:05:17.804Z
Learning: Applies to /CHANGELOG.md : Update `/CHANGELOG.md` for user-visible changes (features, bug fixes, breaking changes, deprecations, performance improvements) to the open-source React on Rails gem and npm package
Applied to files:
docs/upgrading/release-notes/16.1.0.mddocs/upgrading/upgrading-react-on-rails.md
📚 Learning: 2025-04-26T21:55:55.874Z
Learnt from: alexeyr-ci2
Repo: shakacode/react_on_rails PR: 1732
File: spec/dummy/client/app-react16/startup/ReduxSharedStoreApp.client.jsx:40-44
Timestamp: 2025-04-26T21:55:55.874Z
Learning: In the react_on_rails project, files under `app-react16` directories are copied/moved to corresponding `/app` directories during the conversion process (removing the `-react16` suffix), which affects their relative import paths at runtime.
Applied to files:
docs/upgrading/release-notes/16.1.0.mddocs/upgrading/upgrading-react-on-rails.md
📚 Learning: 2025-09-16T08:01:11.146Z
Learnt from: justin808
Repo: shakacode/react_on_rails PR: 1770
File: lib/generators/react_on_rails/templates/base/base/app/javascript/src/HelloWorld/ror_components/HelloWorld.client.jsx:2-2
Timestamp: 2025-09-16T08:01:11.146Z
Learning: React on Rails uses webpack CSS Modules configuration with namedExports: true, which requires the import syntax `import * as style from './file.module.css'` rather than the default export pattern. This configuration enables better tree shaking and bundle size optimization for CSS modules.
Applied to files:
docs/upgrading/release-notes/16.1.0.md
📚 Learning: 2025-11-25T08:05:17.804Z
Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-25T08:05:17.804Z
Learning: Applies to /CHANGELOG*.md : Use changelog format: `[PR 1818](https://github.com/shakacode/react_on_rails/pull/1818) by [username](https://github.com/username)` (no hash in PR number)
Applied to files:
docs/upgrading/release-notes/16.1.0.mddocs/upgrading/upgrading-react-on-rails.md
📚 Learning: 2025-02-12T16:38:06.537Z
Learnt from: Romex91
Repo: shakacode/react_on_rails PR: 1697
File: package-scripts.yml:28-28
Timestamp: 2025-02-12T16:38:06.537Z
Learning: The file `node_package/lib/ReactOnRails.full.js` is autogenerated during the build process and should not be present in the repository.
Applied to files:
docs/upgrading/release-notes/16.1.0.md
🪛 markdownlint-cli2 (0.18.1)
docs/upgrading/release-notes/16.1.0.md
188-188: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
196-196: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: claude-review
🔇 Additional comments (4)
docs/upgrading/upgrading-react-on-rails.md (2)
24-73: Well-structured v16.1.x upgrade section with clear navigation.The section appropriately links to the detailed release notes as the authoritative source while providing a quick summary and streamlined upgrade steps here. The progression (dependencies → install → generator → deprecations) follows best practices. Dependency versions are consistent across both files.
1-473: Ensure file ends with a newline character.Per coding guidelines, all files must end with a newline character before committing. Please verify this file ends with a trailing newline.
docs/upgrading/release-notes/16.1.0.md (2)
1-244: Comprehensive and well-organized release notes covering all upgrade objectives.The documentation effectively covers all requirements from issue #1831: step-by-step upgrade workflow, new features (doctor command, server bundle security), deprecations with migration guidance, bug fixes with PR references (correctly formatted without hash), security enhancements, version compatibility matrix, and thorough troubleshooting section. The structure progresses logically from upgrade steps to features to troubleshooting, making it user-friendly.
1-244: Ensure file ends with a newline character.Per coding guidelines, all files must end with a newline character before committing. Please verify this file ends with a trailing newline.
Summary
docs/upgrading/release-notes/16.1.0.mdChanges
New:
docs/upgrading/release-notes/16.1.0.mdComplete upgrade guide covering:
rake react_on_rails:doctordiagnostic commandserver_bundle_output_path,enforce_private_server_bundles)generated_assets_dirs)Updated:
docs/upgrading/upgrading-react-on-rails.mdCloses #1831
Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.