Skip to content

Commit 2d5656e

Browse files
elliotblackburnkamilogorek
authored andcommitted
docs: Reword sourcemap release docs and make it more visible
1 parent 933c2c8 commit 2d5656e

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/sourcemaps.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,19 @@ Sentry supports un-minifying JavaScript via `Source Maps
88
view source code context obtained from stack traces in their original untransformed form, which is particularly useful for debugging minified code (e.g. UglifyJS), or transpiled code from a higher-level
99
language (e.g. TypeScript, ES6).
1010

11+
Specify the release in Raven.js
12+
-------------------------------
13+
14+
If you are uploading sourcemap artifacts yourself, you must specify the release in your Raven.js client configuration.
15+
Sentry will use the release name to associate digested event data with the files you've uploaded via the `releases API<https://docs.sentry.io/api/releases/>`, `sentry-cli<https://docs.sentry.io/learn/cli/>` or `sentry-webpack-plugin<https://github.com/getsentry/sentry-webpack-plugin>`.
16+
This step is optional if you are hosting sourcemaps on the remote server.
17+
18+
.. code-block:: javascript
19+
20+
Raven.config('your-dsn', {
21+
release: '1.2.3-beta'
22+
}).install();
23+
1124
Generating a Source Map
1225
-----------------------
1326

@@ -340,19 +353,6 @@ Troubleshooting
340353

341354
Source maps can sometimes be tricky to get going. If you're having trouble, try the following tips.
342355

343-
Verify you have specified the release in your client config
344-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
345-
346-
You must specify the active release in your Raven.js client configuration:
347-
348-
.. code-block:: javascript
349-
350-
Raven.config('your-dsn', {
351-
release: '1.2.3-beta'
352-
}).install();
353-
354-
Sentry needs this to associate ingested event data with the release and artifacts you've created via the API.
355-
356356
Verify your source maps are built correctly
357357
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
358358

0 commit comments

Comments
 (0)