Skip to content

docs(readme): Update usage instructions for binary scripts #20426

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

Open
s1gr1d wants to merge 1 commit into
base: develop
Choose a base branch
from
+16 −5
Open

docs(readme): Update usage instructions for binary scripts #20426

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 9 additions & 3 deletions packages/profiling-node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,13 +239,19 @@ the binaries will be copied. This is wasteful as you will likely only need one o
runtime.

To prune the other libraries, profiling-node ships with a small utility script that helps you prune unused binaries. The
script can be invoked via `sentry-prune-profiler-binaries`, use `--help` to see a list of available options or
`--dry-run` if you want it to log the binaries that would have been deleted.
script can be invoked via `sentry-prune-profiler-binaries`:

```bash
npx --package=@sentry/profiling-node sentry-prune-profiler-binaries
```

Use `--help` to see a list of available options or `--dry-run` if you want it to log the binaries that would have been
deleted.

Example of only preserving a binary to run node16 on linux x64 musl.

```bash
sentry-prune-profiler-binaries --target_dir_path=./dist --target_platform=linux --target_node=16 --target_stdlib=musl --target_arch=x64
npx --package=@sentry/profiling-node sentry-prune-profiler-binaries --target_dir_path=./dist --target_platform=linux --target_node=16 --target_stdlib=musl --target_arch=x64
```

Which will output something like
Expand Down
9 changes: 7 additions & 2 deletions packages/remix/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,13 @@ Sentry.captureEvent({
The Remix SDK provides a script that automatically creates a release and uploads sourcemaps. To generate sourcemaps with
Remix, you need to call `remix build` with the `--sourcemap` option.

On release, call `sentry-upload-sourcemaps` to upload source maps and create a release. To see more details on how to
use the command, call `sentry-upload-sourcemaps --help`.
On release, call `sentry-upload-sourcemaps` to upload source maps and create a release:

```bash
npx --package=@sentry/remix sentry-upload-sourcemaps
```

To see more details on how to use the command, call `npx --package=@sentry/remix sentry-upload-sourcemaps --help`.

For more advanced configuration,
[directly use `sentry-cli` to upload source maps.](https://github.com/getsentry/sentry-cli).
Loading