feat(browser): Add __SENTRY_RELEASE__ magic string (#6322)

Author: Luca Forstner

packages/browser/src/sdk.ts

@@ -31,6 +31,11 @@ export const defaultIntegrations = [
   new HttpContext(),
 ];
 
+/**
+ * A magic string that build tooling can leverage in order to inject a release value into the SDK.
+ */
+declare const __SENTRY_RELEASE__: string | undefined;
+
 /**
  * The Sentry Browser SDK Client.
  *
@@ -93,6 +98,11 @@ export function init(options: BrowserOptions = {}): void {
     options.defaultIntegrations = defaultIntegrations;
   }
   if (options.release === undefined) {
+    // This allows build tooling to find-and-replace __SENTRY_RELEASE__ to inject a release value
+    if (typeof __SENTRY_RELEASE__ === 'string') {
+      options.release = __SENTRY_RELEASE__;
+    }
+
     // This supports the variable that sentry-webpack-plugin injects
     if (WINDOW.SENTRY_RELEASE && WINDOW.SENTRY_RELEASE.id) {
       options.release = WINDOW.SENTRY_RELEASE.id;

packages/gatsby/gatsby-browser.js

@@ -25,8 +25,6 @@ exports.onClientEntry = function (_, pluginParams) {
   }
 
   Sentry.init({
-    // eslint-disable-next-line no-undef
-    release: __SENTRY_RELEASE__,
     // eslint-disable-next-line no-undef
     dsn: __SENTRY_DSN__,
     ...pluginParams,

packages/gatsby/test/gatsby-browser.test.ts

@@ -37,8 +37,8 @@ describe('onClientEntry', () => {
   });
 
   it.each([
-    [{}, ['dsn', 'release']],
-    [{ key: 'value' }, ['dsn', 'release', 'key']],
+    [{}, ['dsn']],
+    [{ key: 'value' }, ['dsn', 'key']],
   ])('inits Sentry by default', (pluginParams, expectedKeys) => {
     onClientEntry(undefined, pluginParams);
     expect(sentryInit).toHaveBeenCalledTimes(1);