Skip to content

Add changelog entries for PRs #963 and #900#964

Merged
justin808 merged 2 commits intomainfrom
jg/964-update-changelog-unreleased
Mar 8, 2026
Merged

Add changelog entries for PRs #963 and #900#964
justin808 merged 2 commits intomainfrom
jg/964-update-changelog-unreleased

Conversation

@justin808
Copy link
Copy Markdown
Member

@justin808 justin808 commented Mar 8, 2026

Summary

Test plan

  • yarn lint passes
  • Changelog formatting matches existing conventions

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only change confined to CHANGELOG.md, with no runtime or build behavior impact.

Overview
Updates CHANGELOG.md under [Unreleased] to document two previously-merged changes: a fix preventing Env#current from 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

    • Improved environment variable handling when Rails is not loaded.
  • Documentation

    • Added new Node package API documentation.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 8, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0f15d758-4c92-4786-9f26-3ae37ce936d7

📥 Commits

Reviewing files that changed from the base of the PR and between 7c95c45 and 93861f6.

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

Walkthrough

A 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

Cohort / File(s) Summary
Changelog Updates
CHANGELOG.md
Added v9.6.1 release section with Fixed entries for Env#current guard logic and Documentation entries for Node package API. Updated Unreleased version links and added v9.6.0-to-v9.6.1 comparison link.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A changelog hops in with tales to tell,
Version 9.6.1 rings the release bell,
Guards stand stronger, docs shine bright,
Another small hop toward the light!

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch jg/964-update-changelog-unreleased

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.

❤️ Share

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

Co-Authored-By: Claude Opus 4.6 <[email protected]>
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Mar 8, 2026

Greptile Summary

This PR adds two missing [Unreleased] entries to CHANGELOG.md for previously merged PRs (#963 and #900). The formatting, section ordering (### Fixed### Documentation), and entry style all match the established conventions already present in the v9.6.0 section and earlier releases.

Confidence Score: 5/5

  • This PR is safe to merge — it contains only changelog text additions with no code or configuration changes.
  • The change is limited to two prose entries in CHANGELOG.md. The section names, entry format, PR link format, and contributor attribution all conform exactly to the conventions visible in previous releases. There is no risk of runtime regression.
  • No files require special attention.

Important Files Changed

Filename Overview
CHANGELOG.md Adds two [Unreleased] changelog entries — a bugfix for Env#current crashing outside Rails (PR #963) and a documentation entry for the Node package API guide (PR #900) — both following existing project conventions.

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"]
Loading

Last reviewed commit: 93861f6

@justin808 justin808 merged commit 5672e46 into main Mar 8, 2026
1 check passed
@justin808 justin808 deleted the jg/964-update-changelog-unreleased branch March 8, 2026 22:51
Comment thread CHANGELOG.md

## [Unreleased]

## [v9.6.1] - March 8, 2026
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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:

  1. v9.6.1 has not been released or tagged yet, so there should be no ## [v9.6.1] section in the changelog yet.
  2. Unreleased changes belong under ## [Unreleased], which is now left empty.
  3. The [Unreleased] comparison URL at the bottom was prematurely updated to v9.6.1...main — this link will be broken until v9.6.1 is actually tagged.
Suggested change
## [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).

Comment thread CHANGELOG.md

- **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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

### 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.

Suggested change
### Documentation
### Added

Comment thread CHANGELOG.md
@@ -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)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Suggested change
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

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Mar 8, 2026

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.

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Mar 8, 2026

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.

Comment thread CHANGELOG.md

## [Unreleased]

## [v9.6.1] - March 8, 2026
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread CHANGELOG.md
@@ -866,7 +876,8 @@ Note: [Rubygem is 6.3.0.pre.rc.1](https://rubygems.org/gems/shakapacker/versions

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

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.

1 participant