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

Declare peer dependency on @ember/string for compatibility with Ember >= 5 #359

Conversation

jelhan
Copy link
Contributor

@jelhan jelhan commented Nov 7, 2024

Declaring peer dependency on @ember/string to make the addon compatible with Ember >= 5.

package.json Outdated Show resolved Hide resolved
package.json Outdated
@@ -83,8 +84,7 @@
"node": "12.* || 14.* || >= 16"
},
"volta": {
"node": "16.20.2",
"npm": "6.14.18"
"node": "20.18.0"
Copy link
Contributor

Choose a reason for hiding this comment

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

I guess, this needs to be in separate PR.

@jelhan mind if we keep volta for now as is? I intentionally kept it without changes until v2 conversion is completed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The issue was that the existing lock file was not compatible with the specified NPM version. It was in v2 format not supported by NPM v6. Pinning to a recent version and regenerating lock file was the easiest solution.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

CI was failing. Likely an incompatibility caused by very outdated node 12 used in CI. I restored the original pinned versions of Node and NPM and regenerated the lockfile with that version.

@jelhan
Copy link
Contributor Author

jelhan commented Nov 7, 2024

Do you consider adding an additional peer dependency as a breaking change? If so, we may want to do other breaking changes in the same release.

Potential breaking changes which we may want to ship are

  • Drop support for node < 18
  • Drop support for Ember < 4.12
  • Drop support for ember-get-config < 2

@SergeAstapov
Copy link
Contributor

@jelhan as this addon already depends on ember-auto-import, the conversion to v2 won't be a breaking change itself.
and as a result, v2 addons do not need to declare supported node.js versions, hence updagin Node.js in CI would be non-breaking change for that reason.

Was thinking about dropping support for older Ember versiosn to simplify CI in case if I can't get CI work fine with those old versions.

Considering this change, sounds like we should plan new major as a result of many updates discussed here.

@SergeAstapov
Copy link
Contributor

@jelhan as for CI failures, that's a problem for v5 and up, I haven't get to fixing it in this repo as fixed it in only in ember-changeset.

@jelhan if you'd like to help, I planned to have a separate PR just to bring CI to green state without any major/breaking changes

@jelhan
Copy link
Contributor Author

jelhan commented Nov 7, 2024

@jelhan as for CI failures, that's a problem for v5 and up, I haven't get to fixing it in this repo as fixed it in only in ember-changeset.

Got it.

@jelhan if you'd like to help, I planned to have a separate PR just to bring CI to green state without any major/breaking changes

I have only limited open source time available. If you are already at it, that's great. We can park this PR until CI is fixed.

# Conflicts:
#	.github/workflows/ci.yml
#	config/ember-try.js
#	package-lock.json
#	package.json
@SergeAstapov SergeAstapov changed the title Support Ember v5 Declare peer dependency on @ember/string for compatibility with Ember >= 5 Nov 8, 2024
@SergeAstapov SergeAstapov merged commit 807f2f8 into adopted-ember-addons:master Nov 8, 2024
17 checks passed
@github-actions github-actions bot mentioned this pull request Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants