Add changelog entries for PRs #963 and #900#964
Conversation
Co-Authored-By: Claude Opus 4.6 <[email protected]>
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughA new release section v9.6.1 is added to CHANGELOG.md with entries for bug fixes and documentation improvements. Version links are updated to reflect the new release and maintain version comparison references. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
✨ 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 |
Co-Authored-By: Claude Opus 4.6 <[email protected]>
Greptile SummaryThis PR adds two missing
Confidence Score: 5/5
Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["CHANGELOG.md [Unreleased]"] --> B["### Fixed"]
A --> C["### Documentation"]
B --> D["PR #963 — Fixed Env#current crashing\nwhen Rails is not loaded\nby ihabadham"]
C --> E["PR #900 — Added Node package\nAPI documentation\nby justin808"]
D --> F["defined?(Rails) guard added\nfalls back to RAILS_ENV/RACK_ENV"]
E --> G["New guide: docs/node_package_api.md\nJS API exports, config objects,\nimport entrypoints"]
Last reviewed commit: 93861f6 |
|
|
||
| ## [Unreleased] | ||
|
|
||
| ## [v9.6.1] - March 8, 2026 |
There was a problem hiding this comment.
The PR description says "Added [Unreleased] changelog entries," but these entries are placed under a new [v9.6.1] release section instead of under [Unreleased]. This is a structural problem:
- v9.6.1 has not been released or tagged yet, so there should be no
## [v9.6.1]section in the changelog yet. - Unreleased changes belong under
## [Unreleased], which is now left empty. - The
[Unreleased]comparison URL at the bottom was prematurely updated tov9.6.1...main— this link will be broken until v9.6.1 is actually tagged.
| ## [v9.6.1] - March 8, 2026 | |
| ### Fixed | |
| - **Fixed `Env#current` crashing when Rails is not loaded**. [PR #963](https://github.com/shakacode/shakapacker/pull/963) by [ihabadham](https://github.com/ihabadham). Added `defined?(Rails)` guard to `Shakapacker::Env#current` so it falls back to `RAILS_ENV`/`RACK_ENV` environment variables when called from non-Rails Ruby processes (e.g., `bin/dev` scripts). Previously, this would raise a `NameError` and silently fall back to `"production"`. | |
| ### Added | |
| - **Added Node package API documentation**. [PR #900](https://github.com/shakacode/shakapacker/pull/900) by [justin808](https://github.com/justin808). New guide (`docs/node_package_api.md`) documenting the JavaScript API exports, configuration objects, import entrypoints for webpack and rspack, and built-in third-party support resources. | |
| ## [v9.6.0] - March 7, 2026 |
The entries should live under [Unreleased] and only be moved to a numbered version section when a release is cut (e.g., via bundle exec rake update_changelog).
|
|
||
| - **Fixed `Env#current` crashing when Rails is not loaded**. [PR #963](https://github.com/shakacode/shakapacker/pull/963) by [ihabadham](https://github.com/ihabadham). Added `defined?(Rails)` guard to `Shakapacker::Env#current` so it falls back to `RAILS_ENV`/`RACK_ENV` environment variables when called from non-Rails Ruby processes (e.g., `bin/dev` scripts). Previously, this would raise a `NameError` and silently fall back to `"production"`. | ||
|
|
||
| ### Documentation |
There was a problem hiding this comment.
### Documentation is a non-standard Keep a Changelog section. The canonical sections are: Added, Changed, Deprecated, Removed, Fixed, Security. Adding a new documentation guide is best categorised under ### Added.
| ### Documentation | |
| ### Added |
| @@ -866,7 +876,8 @@ Note: [Rubygem is 6.3.0.pre.rc.1](https://rubygems.org/gems/shakapacker/versions | |||
|
|
|||
| See [CHANGELOG.md in rails/webpacker (up to v5.4.3)](https://github.com/rails/webpacker/blob/master/CHANGELOG.md) | |||
There was a problem hiding this comment.
The [Unreleased] comparison URL was updated to v9.6.1...main prematurely. Since v9.6.1 hasn't been tagged yet, this link is broken. It should stay as v9.6.0...main until a release is actually cut, and the [v9.6.1] line here should not exist yet.
| See [CHANGELOG.md in rails/webpacker (up to v5.4.3)](https://github.com/rails/webpacker/blob/master/CHANGELOG.md) | |
| [Unreleased]: https://github.com/shakacode/shakapacker/compare/v9.6.0...main |
|
Review: Changelog Structure Issues. The intent is correct but the implementation has structural problems. (1) Entries placed under a premature release section: the diff creates a new v9.6.1 section and leaves Unreleased empty. Unreleased changes must stay under Unreleased until a release is cut. The Unreleased comparison URL was updated to v9.6.1...main, a broken link until v9.6.1 is tagged. The v9.6.1 comparison link is also broken. (2) Non-standard section heading: Documentation is not a standard Keep a Changelog section type (Added/Changed/Deprecated/Removed/Fixed/Security). A new docs guide belongs under Added. See inline comments for suggested fixes. |
|
PR review summary: One structural issue - the diff adds entries under a new versioned section v9.6.1 instead of under Unreleased. See inline comment for details. The entry format, Documentation section, and PR link format all match existing project conventions. |
|
|
||
| ## [Unreleased] | ||
|
|
||
| ## [v9.6.1] - March 8, 2026 |
There was a problem hiding this comment.
This adds entries under a new ## [v9.6.1] versioned section, but the PR description says "Added [Unreleased] changelog entries" — these contradict each other.
Per Keep a Changelog conventions and the existing project pattern, a versioned section should only be created when that version is actually tagged and released. Until then, entries belong under ## [Unreleased].
If v9.6.1 has not been released yet, this block (the ## [v9.6.1] heading + its entries) should instead be placed directly under the existing ## [Unreleased] section without a new version heading.
| @@ -866,7 +876,8 @@ Note: [Rubygem is 6.3.0.pre.rc.1](https://rubygems.org/gems/shakapacker/versions | |||
|
|
|||
There was a problem hiding this comment.
These two reference link changes (updating [Unreleased] to point to v9.6.1...main and adding the new [v9.6.1] compare link) are only correct if v9.6.1 has been tagged in git. If the tag doesn't exist yet, the [v9.6.1] comparison URL will 404 and the [Unreleased] link will miss any changes made after this PR but before the eventual release. Both lines should be reverted to [Unreleased]: .../compare/v9.6.0...main until the actual release.
Summary
Env#currentcrashing when Rails is not loaded (bug fix by @ihabadham)Test plan
yarn lintpasses🤖 Generated with Claude Code
Note
Low Risk
Documentation-only change confined to
CHANGELOG.md, with no runtime or build behavior impact.Overview
Updates
CHANGELOG.mdunder [Unreleased] to document two previously-merged changes: a fix preventingEnv#currentfrom crashing when Rails isn’t loaded, and new documentation for the Node package JavaScript API (docs/node_package_api.md).Written by Cursor Bugbot for commit 81bf2b8. Configure here.
Summary by CodeRabbit
Bug Fixes
Documentation