From 80b2d4e17a1416410ee74e421147cca97f245f7e Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Thu, 21 Apr 2022 11:03:34 +0200 Subject: [PATCH 1/3] Adjust JS CDN bundle page to reflect ES5/ES6 naming changes --- src/platforms/javascript/common/install/cdn.mdx | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/src/platforms/javascript/common/install/cdn.mdx b/src/platforms/javascript/common/install/cdn.mdx index be1e6a6e07edd..407944a565a32 100644 --- a/src/platforms/javascript/common/install/cdn.mdx +++ b/src/platforms/javascript/common/install/cdn.mdx @@ -16,6 +16,13 @@ Sentry supports loading the JavaScript SDK from a CDN. Generally we suggest usin > ``` + + +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). + + + ## 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. @@ -30,7 +37,7 @@ To use Sentry's performance tracing, an alternative bundle is needed. This allow -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`. @@ -57,13 +64,13 @@ Our CDN hosts a variety of bundles: - `@sentry/browser` and `@sentry/tracing` together (named `bundle.tracing..js`) - each of the integrations in `@sentry/integrations` (named `..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 From 6ce825e3c9a344d30eb0fbeaf3cfefb8b188144c Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Thu, 21 Apr 2022 16:46:21 +0200 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --- src/platforms/javascript/common/install/cdn.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/platforms/javascript/common/install/cdn.mdx b/src/platforms/javascript/common/install/cdn.mdx index 407944a565a32..54d15e97843db 100644 --- a/src/platforms/javascript/common/install/cdn.mdx +++ b/src/platforms/javascript/common/install/cdn.mdx @@ -16,10 +16,10 @@ Sentry supports loading the JavaScript SDK from a CDN. Generally we suggest usin > ``` - + 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). +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). From ab52979b6f12f996c5e5b58a2c9e9f0daf8d2df0 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Mon, 30 May 2022 14:19:12 +0200 Subject: [PATCH 3/3] Update link --- src/platforms/javascript/common/install/cdn.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platforms/javascript/common/install/cdn.mdx b/src/platforms/javascript/common/install/cdn.mdx index 54d15e97843db..f891b588bda74 100644 --- a/src/platforms/javascript/common/install/cdn.mdx +++ b/src/platforms/javascript/common/install/cdn.mdx @@ -19,7 +19,7 @@ Sentry supports loading the JavaScript SDK from a CDN. Generally we suggest usin 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). +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](https://github.com/getsentry/sentry-javascript/blob/master/MIGRATION.md#upgrading-from-6x-to-7x).