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 upgrading to v8 guide #464

Merged
merged 1 commit into from
Nov 16, 2022
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
27 changes: 27 additions & 0 deletions UPGRADING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Upgrading

## v8

The most notable breaking changes introduced in v8 are:

1. The `includePolyfill` option is no longer supported ([458](https://github.com/babel/ember-cli-babel/pull/458))
2. `@babel/core` is now a required peer dependency ([452](https://github.com/babel/ember-cli-babel/pull/452))

### Upgrade Path for Apps

Apps that are relying on the `includePolyfill` option should install `core-js`,
and import `core-js/stable` directly in `app.js`. The reason for this is that,
`@babel/polyfill` has been deprecated. More info on this deprecation can be
found in [the documentation for `@babel/polyfill`](https://babeljs.io/docs/en/babel-polyfill).

Apps are now also required to install `@babel/core` directly in order to use
`ember-cli-babel`. Making `@babel/core` a peer dependency ensures that the
same version is used by all tooling that require it.

### Upgrade Path for Addons

Since (v1) addons bring in their own version of `ember-cli-babel`, they should
now also bring in their own version of `@babel/core`. This means that, addons
should add `@babel/core` under `dependencies` in their `package.json` file.
This makes the dependency on `@babel/core` more explicit while also avoiding
addons having to cut a breaking release to update `ember-cli-babel` to v8.