Skip to content

Commit bf4a15c

Browse files
authored
ref(js): Improve Sentry CLI source maps upload guide (#7875)
1 parent 1f3886c commit bf4a15c

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

src/docs/product/cli/releases.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ The value can be arbitrary, but for certain platforms, recommendations exist:
2828
- if you use a DVCS we recommend using the identifying hash (eg: the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let sentry-cli automatically determine this hash for supported version control systems with `sentry-cli releases propose-version`.
2929
- if you tag releases we recommend using the release tag prefixed with a product or package name (for example, `my-project-name@2.3.12`).
3030

31+
```bash
32+
#!/bin/sh
33+
sentry-cli releases new "$VERSION"
34+
```
35+
3136
Releases can also be auto created by different systems. For instance upon uploading a source map a release is automatically created. Likewise releases are created by some clients when an event for a release comes in.
3237

3338
## Finalizing Releases

src/includes/sentry-cli-sourcemaps.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,8 @@ sentry-cli sourcemaps upload --release=<release_name> /path/to/directory
8282

8383
<Note>
8484

85-
Running `upload` with `--release` **doesn't automatically create a release in Sentry**. For that, you should create a release with the same name as a separate step in your pipeline or send the first event to Sentry with that release.
85+
Running `upload` with `--release` **doesn't automatically create a release in Sentry**.
86+
Either wait until the first event with the new release set in `Sentry.init` is sent to Sentry, or create a release with the same name in a separate step [with the CLI](/product/cli/releases).
8687

8788
</Note>
8889

0 commit comments

Comments
 (0)