Skip to content

Commit

Permalink
ref(js): Improve Sentry CLI source maps upload guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Lms24 committed Sep 19, 2023
1 parent aa2c1d3 commit b5b52e9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
5 changes: 5 additions & 0 deletions src/docs/product/cli/releases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@ The value can be arbitrary, but for certain platforms, recommendations exist:
- 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`.
- 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`).

```bash
#!/bin/sh
sentry-cli releases new "$VERSION"
```

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.

## Finalizing Releases
Expand Down
3 changes: 2 additions & 1 deletion src/includes/sentry-cli-sourcemaps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,8 @@ sentry-cli sourcemaps upload --release=<release_name> /path/to/directory

<Note>

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.
Running `upload` with `--release` **doesn't automatically create a release in Sentry**.
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).

</Note>

Expand Down

0 comments on commit b5b52e9

Please sign in to comment.