Add migration guide for v7 #4910
Merged
Conversation
This file contains hidden or 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
5 tasks
size-limit report 📦
|
Lms24
reviewed
Apr 11, 2022
| **CDN bundles of version 7 or higher will no longer be distributed through our npm package.** | ||
| This means that most third-party CDNs like [unpkg](https://unpkg.com/) or [jsDelivr](https://www.jsdelivr.com/) will also not provide them. | ||
|
|
||
| If you depend on any specific files in a Sentry JavaScript npm package, you will most likely need to update their references. |
There was a problem hiding this comment.
Should we give an example of changing an import from e.g. @sentry/somePkg/dist/... to @sentry/somePkg (recommended) or @sentry/somePkg/cjs/.. (if really necessary)?
MIGRATION.md
Outdated
|
|
||
| If you depend on any specific files in a Sentry JavaScript npm package, you will most likely need to update their references. | ||
|
|
||
| ### Removing the `API` class from `@sentry/core`` |
There was a problem hiding this comment.
Suggested change
| ### Removing the `API` class from `@sentry/core`` | |
| ### Removing the `API` class from `@sentry/core` |
MIGRATION.md
Outdated
|
|
||
| ### Restructuring Of Package Content | ||
|
|
||
| Up until now, we have published our packages on npm with the following structure: |
There was a problem hiding this comment.
Sorry for the nit but I think it's better to be specific here. Totally optional though.
Suggested change
| Up until now, we have published our packages on npm with the following structure: | |
| Up until v6.x, we have published our packages on npm with the following structure: |
MIGRATION.md
Outdated
|
|
||
| ### Removing the `API` class from `@sentry/core`` | ||
|
|
||
| The internal `API` class was removed. More details can be found in the [PR that deprecated this class](https://github.com/getsentry/sentry-javascript/pull/4281). To migrate, see the following example. |
There was a problem hiding this comment.
Again an optional suggestion but for me it makes sense to specify that the functionality is not lost (if I understand the PRs correctly).
Suggested change
| The internal `API` class was removed. More details can be found in the [PR that deprecated this class](https://github.com/getsentry/sentry-javascript/pull/4281). To migrate, see the following example. | |
| The internal `API` class was removed in favour of functions. More details can be found in the [PR that deprecated this class](https://github.com/getsentry/sentry-javascript/pull/4281). To migrate, see the following example. |
AbhiPrasad
approved these changes
Apr 11, 2022
|
I'm gonna go ahead and merge this in so we can iterate on it as needed. |
|
we kinda messed up the commit name here but whatever |
lobsterkatie
pushed a commit
that referenced
this pull request
Apr 13, 2022
Documents: - ES6 for CJS files - Dropping Support for Node v6 - Removing Platform Integrations - New npm package structure - Deleting deprecations
Lms24
pushed a commit
that referenced
this pull request
Apr 26, 2022
Documents: - ES6 for CJS files - Dropping Support for Node v6 - Removing Platform Integrations - New npm package structure - Deleting deprecations
lobsterkatie
pushed a commit
that referenced
this pull request
Apr 26, 2022
Documents: - ES6 for CJS files - Dropping Support for Node v6 - Removing Platform Integrations - New npm package structure - Deleting deprecations
lobsterkatie
pushed a commit
that referenced
this pull request
Apr 26, 2022
Documents: - ES6 for CJS files - Dropping Support for Node v6 - Removing Platform Integrations - New npm package structure - Deleting deprecations
AbhiPrasad
pushed a commit
that referenced
this pull request
May 30, 2022
Documents: - ES6 for CJS files - Dropping Support for Node v6 - Removing Platform Integrations - New npm package structure - Deleting deprecations
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is adding a migration guide for migrating from 6.x to 7.x.
Currently the following changes need to be documented:
Please let me know if I forgot something in the list above!
Ref: