-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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 mdn- and Node.js 8 deprecation warnings for 1.1 release #6777
Merged
Merged
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
03cf0ff
Add deprecation notices
ddbeck 85ec86a
Add upgrade docs
ddbeck 0276e80
Add upgrade docs URL to deprecation notice
ddbeck 8677b4d
Add upgrade docs link to README
ddbeck 76bdf33
Copyedit upgrade docs
ddbeck 186abfb
Use full semver version in UPGRADE doc
ddbeck 5fb6692
Only check the Node.js version once
ddbeck 638d3fc
Fix grammar in README
ddbeck 11551cd
Link back to breaking changes list
ddbeck 2aba539
Fix undercaffeination error
ddbeck File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Upgrading from `mdn-browser-compat-data` 1.1 to `@mdn/browser-compat-data` 2.0.x | ||
|
||
`mdn-browser-compat-data` has been renamed to `@mdn/browser-compat-data` (note the `@mdn` scope). Follow these instructions to upgrade to the new package name. | ||
|
||
## Before you start | ||
|
||
This upgrade causes two breaking changes: | ||
|
||
- The old package name no longer works, which means you'll have to update `require()` calls and your `package.json` dependencies. | ||
- Node.js 8 is no longer supported, which means you'll have to upgrade to Node.js 10 or later. | ||
|
||
The schema, public API, and other details of the package remain the same since `1.1.x`. | ||
|
||
## Upgrade | ||
|
||
1. If you have not done so already, upgrade to Node.js 10 or later. Visit the [Node.js site](https://nodejs.org/) for downloads and changelogs. | ||
|
||
2. Remove `mdn-browser-compat-data` from your package dependencies. | ||
|
||
In the same directory as your `package.json` file, run `npm uninstall mdn-browser-compat-data`. | ||
|
||
3. Add `@mdn/browser-compat-data` to your package dependencies. | ||
|
||
In the same directory as your `package.json` file, run `npm install @mdn/browser-compat-data`. | ||
|
||
4. In your code, replace any `require("mdn-browser-compat-data")` calls with `require("@mdn/browser-compat-data")`. | ||
|
||
If possible, run your test suite to make sure this worked. | ||
|
||
If you encountered any undocumented breaking changes as a result of this upgrade, please [open an issue](https://github.com/mdn/browser-compat-data/issues/new). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Link "breaking changes" to the section named "Before you start", above, as this is where the breaking changes are documented? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 Fixed with 11551cd. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
soon-to-be
doesn't need hyphens in this context, imo. If it was in a context like "The soon-to-be-renamed browser-compat-data package", then it would have hyphens.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, fixed with 638d3fc. I wasn't sure if I was modifying is or renamed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And fixed again with 2aba539.