Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(cli): Improve Releases page wording #10288

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

docs(cli): Improve Releases page wording #10288

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d276b2d
docs: Update legacy commands to `sentry-cli files`
szokeasaurusrex Jun 4, 2024
593ae4d
Update docs/cli/releases.mdx
lizokm Jun 4, 2024
7110530
docs(cli): Improve Releases page wording
szokeasaurusrex Jun 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/cli/releases.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,22 +118,22 @@ sentry-cli releases set-commits "$VERSION" --auto --ignore-missing

## Managing Release Artifacts

When you are working with JavaScript and other platforms, you can upload release artifacts to Sentry which are then considered during processing. The most common release artifact are [source maps](/platforms/javascript/sourcemaps/) for which `sentry-cli` has specific support.
When you're working with JavaScript and other platforms, you can upload release artifacts (which are taken into account during processing) to Sentry. The `sentry-cli` has specific support for [source maps](/platforms/javascript/sourcemaps/), which are our most common release artifacts.

To manage release artifacts the `sentry-cli releases files` command can be used which itself provides various sub commands.
The `sentry-cli files` command (which provides various sub-commands) can be used to manage release artifacts.

### Upload Files

The most common use case is to upload files. For the generic upload the `sentry-cli releases files VERSION upload` command can be used. However since most release artifacts are JavaScript source map related we have a [Upload Source Maps](#sentry-cli-sourcemaps) convenience method for that.
The most common use case is to upload files. For the generic upload, the `sentry-cli files upload` command can be used. However, since most release artifacts are JavaScript source map related, we have an [Upload Source Maps](/cli/releases/#upload-source-maps) convenience method for that.

Files uploaded are typically named with a full (eg: `http://example.com/foo.js`) or truncated URL (eg: `~/foo.js`).

Release artifacts are only considered at time of event processing. So while it’s possible to modify release artifacts after the fact they will only be considered for future events of that release.

The first argument to `upload` is the path to the file, the second is an optional URL we should associate it with. Note that if you want to use an abbreviated URL (eg: `~/foo.js`) make sure to use single quotes to avoid the expansion by the shell to your home folder.
The first argument to `upload` is the path to the file. The second is an optional URL we should associate it with. If you want to use an abbreviated URL (`~/foo.js`, for example), make sure you're using single quotes to avoid the shell expansion to your home folder.

```bash
sentry-cli releases files "$VERSION" upload /path/to/file '~/file.js'
sentry-cli files upload --release "$VERSION" /path/to/file '~/file.js'
```

### Upload Source Maps
Expand Down Expand Up @@ -217,7 +217,7 @@ sentry-cli sourcemaps upload /path/to/sourcemaps --ignore-file .sentryignore
To list uploaded files, the following command can be used:

```bash
sentry-cli releases files "$VERSION" list
sentry-cli files list --release "$VERSION"
```

This will return a list of all uploaded files for that release.
Expand All @@ -227,8 +227,8 @@ This will return a list of all uploaded files for that release.
You can also delete already uploaded files. Either by name or all files at once:

```bash
sentry-cli releases files "$VERSION" delete NAME_OF_FILE
sentry-cli releases files "$VERSION" delete --all
sentry-cli files delete --release "$VERSION" NAME_OF_FILE
sentry-cli files delete --release "$VERSION" --all
```

## Creating Deploys
Expand Down