Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add changelog entry regarding custom bin path removal #490

Merged
merged 1 commit into from
Jun 19, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ See the [v8 Upgrade Guide](https://github.com/shakacode/shakapacker/blob/main/do
This enables support for package managers other than `yarn`, with `npm` being the default; to continue using Yarn,
specify it in `package.json` using the [`packageManager`](https://nodejs.org/api/packages.html#packagemanager) property.

This also removed `@node_modules_bin_path`, `SHAKAPACKER_NODE_MODULES_BIN_PATH`, and support for installing `Shakapacker`'s javascript package in a separate directory from the Gemfile containing `Shakapacker`'s ruby gem.
Copy link
Member

Choose a reason for hiding this comment

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

@G-Rath @tomdracz this seems like a bug. Why was this removed? Could this be added back?

Copy link
Contributor

Choose a reason for hiding this comment

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

Because Shakapacker no longer needs it now that package_json is being used to handle package managers (and by extension running commands), and it's not valid in all contexts e.g. Yarn Berry w/ PnP enabled doesn't have a node_modules

Copy link
Collaborator

Choose a reason for hiding this comment

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

I agree that this is useful to highlight but wouldn't backtrack here.
Don't think this functionality/ENV variable was ever documented so it was fair bit of tribal knowledge either way. Actually never seen it in the wild nor noticed it before

Copy link
Member

Choose a reason for hiding this comment

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

Original and many react_on_rails projects had the client code in a client directory, including package.json.

Copy link
Member

@justin808 justin808 Jun 7, 2024

Choose a reason for hiding this comment

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

However, it's not hard to migrate.

Copy link
Member

Choose a reason for hiding this comment

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

Need to mention this in the upgrade doc, and how to remedy this issue with top level package.json


Comment on lines +48 to +49
Copy link

Choose a reason for hiding this comment

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

Clarify the impact of the removed features in the changelog.

The changelog entry on lines 48-49 mentions the removal of @node_modules_bin_path, SHAKAPACKER_NODE_MODULES_BIN_PATH, and the support for installing Shakapacker's JavaScript package in a separate directory. However, it would be beneficial for users if the entry also briefly explained the reason for these removals and their potential impact on existing setups. This would align with the PR's objective to clarify significant changes and help prevent confusion.

- Remove `yarn_install` rake task, and stop installing js packages automatically as part of `assets:precompile` [PR 412](https://github.com/shakacode/shakapacker/pull/412) by [G-Rath](https://github.com/g-rath).

- Remove `check_yarn` rake task [PR 443](https://github.com/shakacode/shakapacker/pull/443) by [G-Rath](https://github.com/g-rath).
Expand Down
Loading