docs: update README and guides for Shakapacker v10#1092
Conversation
WalkthroughDocumentation updates across the repository to change Shakapacker references, dependency snippets, upgrade links, and migration/release examples from v9 to v10; wording updated to reflect v10 as the current default for several features while preserving prior behavioral explanations where noted. (49 words) 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 |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Review: docs: update README and guides for Shakapacker v10Good direction overall — the broad v9→v10 version bumps in version-pinned examples (README, Factual errors (features attributed to the wrong version)The main pattern to watch for: a feature was introduced in v9 and simply carried forward in v10. Several changes re-attribute those features to v10, which would mislead v9 users into thinking they need to upgrade.
Migration section titles
Pre-release version table inconsistency
|
Greptile SummaryDocumentation-only PR that updates version identifiers, npm/gem dependency snippets, and upgrade-path links throughout README and 11 doc files to reflect Shakapacker v10 as the current release. Historical v8→v9 context is largely preserved, and most files use careful phrasing (e.g., "introduced in v9, continues in v10"). Two spots apply a blunter v9→v10 replacement that slightly misrepresents when the relevant features shipped. Confidence Score: 5/5Safe to merge — docs-only changes with no code or test impact. All findings are P2 style/accuracy suggestions. The two flagged spots are minor historical-attribution issues that don't break any functionality or user path. docs/optional-peer-dependencies.md and docs/css-modules-export-mode.md have minor historical-attribution wording worth a second look. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[v5 or earlier] -->|V6 Upgrade Guide| B[v6]
B -->|V7 Upgrade Guide| C[v7]
C -->|V8 Upgrade Guide| D[v8]
D -->|V9 Upgrade Guide
docs/v9_upgrade.md| E[v9]
E -->|v10.0.0 Release Notes
github releases tag| F[v10 ✅ Current]
D -.->|Direct upgrade path
docs updated in this PR| F
style F fill:#22c55e,color:#fff
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Review: docs: update README and guides for Shakapacker v10Overall this is a clean, well-scoped documentation refresh. The version bump mechanics are correct and the added v10 release notes link in README/common-upgrades is a nice touch. A few issues worth addressing: Issues1. Version precision lost in transpiler-migration.md 2. Codemod filename rename is misleading (css-modules-export-mode.md) 3. Version comparison table header drops v9 context 4. optional-peer-dependencies.md skips v9 step |
|
Overall this is a well-structured docs sweep. Version bumps are consistent and the historical v8-to-v9 migration guidance is correctly preserved. A couple of things to check before merge: (1) verify the v10.0.0 release tag exists -- README and common-upgrades.md now link to github.com/shakacode/shakapacker/releases/tag/v10.0.0 and if that release has not been published it will 404; (2) the SWC phrasing in README.md:927 was changed from 'v9+' to just 'v10', while using_swc_loader.md more helpfully says 'v10 (this default was introduced in v9)' -- worth applying the same pattern to README for users upgrading from v9; (3) see inline comments on an awkward table cell and section header. |
Review: docs: update README and guides for Shakapacker v10This is a clean, well-scoped documentation refresh. The previous rounds of review clearly had an effect — the most significant issues (incorrect v10-only attribution for optional peer deps, inconsistent pre-release version table, migration heading accuracy) are all resolved in the latest commit. The Three remaining nits1. 2. 3. Everything else looks good
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c6c7be0e38
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Review: docs: update README and guides for Shakapacker v10Overall this is a clean, well-scoped docs-only PR. Version references are consistently bumped, historical v8→v9 migration context is preserved, and no runtime logic was touched. A couple of small issues are worth addressing before merging. Issues1. Inconsistent The Gemfile example was updated to offer a v10 option ( 2. Mixed versioning in The section heading was updated from "v9" → "v10" but the first bullet still reads "New installations (v9+)". It's technically accurate (SWC default was introduced in v9), but landing on a "v10 transpiler defaults" heading and then reading "v9+" on the next line is jarring. A small clarifying tweak like "v9+, including v10" or "v9+ (including v10)" in that bullet would make it read smoothly (see inline comment). Minor observation (no change needed)The v10 upgrade pointer in README now links to GitHub release notes rather than a local |
Review: docs update for Shakapacker v10The version-bump sweep is thorough and consistent across the eight files. The upgrade-path hierarchy in Issues found
Inline suggestions are attached to each location above. Looks good
|
…ting Use jsonc fence so // comments are valid, make ~> 10.0 / ^10.0.0 the primary examples (bounded), and demote >= 9.1.1 to fallback for v9 users. Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
Review comments addressedAll 24 inline review threads have been replied to and resolved. Fixed in c24f59e
Already addressed in earlier commits (b52c6ba..8000dea)The remaining 22 comments about v9 attribution accuracy were all fixed in prior commits — v9 provenance is correctly preserved throughout the docs. |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/rspack_migration_guide.md (1)
422-423: Clarify upgrade scope wording to avoid mixed signals.Line 422 currently combines “upgrading to v10” with “or any v9+ app,” which reads as two different scopes. Consider splitting this into two sentences (v10 upgrade path + note that the same guidance applies to v9+ apps).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/rspack_migration_guide.md` around lines 422 - 423, The sentence "When upgrading to Shakapacker v10 with Rspack (or any v9+ app):" conflates two scopes; edit the document to split it into two clear sentences — one stating "When upgrading to Shakapacker v10 with Rspack:" to introduce the v10 upgrade path and a separate note like "This guidance also applies to apps running Shakapacker v9 and above." — locate and replace the exact phrase in docs/rspack_migration_guide.md to ensure clarity.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/rspack_migration_guide.md`:
- Around line 422-423: The sentence "When upgrading to Shakapacker v10 with
Rspack (or any v9+ app):" conflates two scopes; edit the document to split it
into two clear sentences — one stating "When upgrading to Shakapacker v10 with
Rspack:" to introduce the v10 upgrade path and a separate note like "This
guidance also applies to apps running Shakapacker v9 and above." — locate and
replace the exact phrase in docs/rspack_migration_guide.md to ensure clarity.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 400ffd8b-957d-4a90-9ed5-d3608433ebcf
📒 Files selected for processing (8)
README.mddocs/css-modules-export-mode.mddocs/optional-peer-dependencies.mddocs/react.mddocs/rspack_migration_guide.mddocs/transpiler-migration.mddocs/troubleshooting.mddocs/using_swc_loader.md
✅ Files skipped from review due to trivial changes (6)
- docs/react.md
- docs/using_swc_loader.md
- docs/optional-peer-dependencies.md
- docs/transpiler-migration.md
- docs/troubleshooting.md
- README.md
|
|
||
| # For a release candidate | ||
| bundle exec rake "release[9.6.0.rc.0]" | ||
| bundle exec rake "release[10.6.0.rc.0]" |
There was a problem hiding this comment.
The RC example 10.6.0.rc.0 was mechanically bumped from the old 9.6.0.rc.0 (which reflected a real v9 release at the time). Now it reads as though v10.6 already exists, which contradicts the 10.0.0.rc.1 example in the "Examples" section lower in this same file (line ~151).
| bundle exec rake "release[10.6.0.rc.0]" | |
| bundle exec rake "release[10.0.0.rc.0]" |
| When called with no arguments, `release`: | ||
|
|
||
| 1. Reads the first versioned header from CHANGELOG.md (e.g., `## [v9.6.0]`) | ||
| 1. Reads the first versioned header from CHANGELOG.md (e.g., `## [v10.6.0]`) |
There was a problem hiding this comment.
Same issue — v10.6.0 as the "reads from CHANGELOG" example implies a non-existent release. v10.0.0 (or v10.1.0) would be more accurate as a v10-era example.
| 1. Reads the first versioned header from CHANGELOG.md (e.g., `## [v10.6.0]`) | |
| 1. Reads the first versioned header from CHANGELOG.md (e.g., `## [v10.0.0]`) |
Review: docs update for Shakapacker v10Overall this is a clean, focused documentation update. The approach of preserving v8→v9 migration history while positioning v10 as current is correct, and the added v10 release-notes link is a good touch. One pattern to fixSeveral example version numbers in Small nits (no action required)
|
* origin/main: (22 commits) docs: add Dependabot configuration guide (#1094) Sync address-review prompt with upstream PR #16 (#1098) Supersede #910: entry shape test with lint unblock (#919) fix: align rspack v2 peer deps and installer defaults (#1091) docs: update README and guides for Shakapacker v10 (#1092) Release 10.0.0 Update CHANGELOG.md for v10.0.0 (#1089) Release 10.0.0-rc.1 Update CHANGELOG.md for v10.0.0-rc.1 (#1087) Supersede #961 by using pack-config-diff (#973) Add final summary output to rake release (#1041) Add bin/setup to install development deps (#1039) Release 10.0.0-rc.0 Use npx release-it to avoid mise shim failures (#1040) Fix Nokogiri build failure on Ruby 3.4.6 (#1038) Update CHANGELOG.md for v10.0.0-rc.0 (#1037) Update rspack dev deps to 2.0.0-rc.0 (#1036) Fix stale and broken documentation across Shakapacker guides (#1023) Allow webpack-cli v7 in peer dependencies (#1021) refactor: simplify resolving js peer versions when installing (#1034) ... # Conflicts: # package.json
* origin/main: docs: add Dependabot configuration guide (#1094) Sync address-review prompt with upstream PR #16 (#1098) Supersede #910: entry shape test with lint unblock (#919) fix: align rspack v2 peer deps and installer defaults (#1091) docs: update README and guides for Shakapacker v10 (#1092) Release 10.0.0 Update CHANGELOG.md for v10.0.0 (#1089) Release 10.0.0-rc.1 Update CHANGELOG.md for v10.0.0-rc.1 (#1087) Supersede #961 by using pack-config-diff (#973) # Conflicts: # CHANGELOG.md # Rakefile
1 participant
Summary
shakapackergem/npm snippets) and upgrade references, including adding a v10 release-notes link.Pull Request checklist
Add/update test to cover these changesUpdate CHANGELOG fileOther Information
npx prettier --checkon all modified Markdown files (with one auto-format pass ondocs/rspack_migration_guide.md).Note
Low Risk
Documentation-only updates that re-label v10 as current and refresh versioned examples/links; no runtime or build logic changes.
Overview
Updates the docs to position Shakapacker v10 as the current release, including adding a
v10.0.0upgrade/release-notes link and revising language that previously treated v9 as “current.”Refreshes all versioned snippets (Gemfile/package.json examples, peer-deps examples, release commands, and troubleshooting upgrade guidance) to
10.x, while clarifying that several defaults/breaking changes (e.g., SWC-by-default in templates, CSS Modules named exports) were introduced in v9 and continue in v10.Reviewed by Cursor Bugbot for commit c24f59e. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit