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.

Sign up for GitHub

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

Adjust JS CDN bundle page to reflect ES5/ES6 naming changes #4962

Merged
merged 3 commits into from
May 30, 2022
Merged

Adjust JS CDN bundle page to reflect ES5/ES6 naming changes #4962

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80b2d4e
Adjust JS CDN bundle page to reflect ES5/ES6 naming changes
lforst Apr 21, 2022
6ce825e
Apply suggestions from code review
lforst Apr 21, 2022
ab52979
Update link
lforst May 30, 2022
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
17 changes: 12 additions & 5 deletions src/platforms/javascript/common/install/cdn.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ Sentry supports loading the JavaScript SDK from a CDN. Generally we suggest usin
></script>
```

<Alert level="info" title="Updates to naming scheme in SDK version 7">

Version 7 of the Sentry JavaScript SDKs changed the bundles to be ES6 by default.
Previously, the default bundles were compiled to ES5. If you need to support ES5, see [Available Bundles](#available-bundles) or the [Migration Guide to Version 7](TODO).

</Alert>

## Performance Bundle

To use Sentry's performance tracing, an alternative bundle is needed. This allows us to keep the filesize down for users who only need error monitoring.
Expand All @@ -30,7 +37,7 @@ To use Sentry's performance tracing, an alternative bundle is needed. This allow

<Note>

You only need to load `bundle.tracing.min.js`, which provides both error and performance monitoring. There is also an ES6 version of the tracing bundle, `bundle.tracing.es6.min.js`.
You only need to load `bundle.tracing.min.js`, which provides both error and performance monitoring. There is also an ES5 version of the tracing bundle, `bundle.tracing.es5.min.js`.

</Note>

Expand All @@ -57,13 +64,13 @@ Our CDN hosts a variety of bundles:
- `@sentry/browser` and `@sentry/tracing` together (named `bundle.tracing.<modifiers>.js`)
- each of the integrations in `@sentry/integrations` (named `<integration-name>.<modifiers>.js`)

Each bundle is offered in both ES5 and ES6 versions, and for each version there are three bundle varieties: unminified, minified, and minified with debug logging. (That last version can be helpful for times when you need to debug an issue which only occurs in production. In a development environment, it makes most sense to use the unminified bundle, which always includes logging.)
Each bundle is offered in both ES6 and ES5 versions, and for each version there are three bundle varieties: unminified, minified, and minified with debug logging. (That last version can be helpful for times when you need to debug an issue which only occurs in production. In a development environment, it makes most sense to use the unminified bundle, which always includes logging.)

For example:

- `bundle.js` is `@sentry/browser`, compiled to ES5 but not minified, with debug logging included (as it is for all unminified bundles)
- `rewriteframes.es6.min.js` is the `RewriteFrames` integration, compiled to ES6 and minified, with no debug logging
- `bundle.tracing.es6.debug.min.js` is `@sentry/browser` and `@sentry/tracing` bundled together, compiled to ES6 and minified, with debug logging included
- `bundle.js` is `@sentry/browser`, compiled to ES6 but not minified, with debug logging included (as it is for all unminified bundles)
- `rewriteframes.es5.min.js` is the `RewriteFrames` integration, compiled to ES5 and minified, with no debug logging
- `bundle.tracing.es5.debug.min.js` is `@sentry/browser` and `@sentry/tracing` bundled together, compiled to ES5 and minified, with debug logging included

<JsBundleList />

Expand Down