Use debug-files upload instead of upload-dif (#7091)

marandaneto · web-flow · commit de35a0829c15 · 2023-06-05T15:31:51.000+02:00
diff --git a/src/docs/clients/cocoa/dsym.mdx b/src/docs/clients/cocoa/dsym.mdx
@@ -56,7 +56,7 @@ There are two ways to download the dSYM from iTunesConnect. After you do one of
 Afterwards manually upload the symbols with _sentry-cli_:
 
 ```bash
-sentry-cli --auth-token YOUR_AUTH_TOKEN upload-dif --org YOUR_ORG_SLUG --project YOUR_PROJECT_SLUG PATH_TO_DSYMS
+sentry-cli --auth-token YOUR_AUTH_TOKEN debug-files upload --org YOUR_ORG_SLUG --project YOUR_PROJECT_SLUG PATH_TO_DSYMS
 ```
 
 <Note>
@@ -114,7 +114,7 @@ if which sentry-cli >/dev/null; then
 export SENTRY_ORG=___ORG_SLUG___
 export SENTRY_PROJECT=___PROJECT_SLUG___
 export SENTRY_AUTH_TOKEN=YOUR_AUTH_TOKEN
-ERROR=$(sentry-cli upload-dif "$DWARF_DSYM_FOLDER_PATH" 2>&1 >/dev/null)
+ERROR=$(sentry-cli debug-files upload "$DWARF_DSYM_FOLDER_PATH" 2>&1 >/dev/null)
 if [ ! $? -eq 0 ]; then
 echo "warning: sentry-cli - $ERROR"
 fi
@@ -153,10 +153,10 @@ Your dSYM file can be upload manually by you (or some automated process) with th
 
 Download and install [sentry-cli](https://github.com/getsentry/sentry-cli/releases) — The best place to put this is in the _/usr/local/bin/_ directory.
 
-Then run this (note that `--auth-token` needs to go before `upload-dif`):
+Then run this:
 
 ```bash
-sentry-cli --auth-token YOUR_AUTH_TOKEN upload-dif --org YOUR_ORG_SLUG --project YOUR_PROJECT_SLUG PATH_TO_DSYMS
+sentry-cli --auth-token YOUR_AUTH_TOKEN debug-files upload --org YOUR_ORG_SLUG --project YOUR_PROJECT_SLUG PATH_TO_DSYMS
 ```
 
 <Note>
diff --git a/src/docs/clients/react-native/manual-setup.mdx b/src/docs/clients/react-native/manual-setup.mdx
@@ -80,7 +80,7 @@ If you wish to upload the source maps and symbols to Sentry, create a new Run Sc
 ```bash
 export SENTRY_PROPERTIES=../sentry.properties
 
-../node_modules/@sentry/cli/bin/sentry-cli upload-dif "$DWARF_DSYM_FOLDER_PATH"
+../node_modules/@sentry/cli/bin/sentry-cli debug-files upload "$DWARF_DSYM_FOLDER_PATH"
 ```
 
 For bitcode enabled builds via iTunes Connect, additional steps are required.
@@ -176,7 +176,7 @@ fi
 [ -z "$NODE_BINARY" ] && export NODE_BINARY="node"
 
 # Run sentry cli script to upload debug symbols
-$NODE_BINARY ../node_modules/@sentry/cli/bin/sentry-cli upload-dif "$DWARF_DSYM_FOLDER_PATH"
+$NODE_BINARY ../node_modules/@sentry/cli/bin/sentry-cli debug-files upload "$DWARF_DSYM_FOLDER_PATH"
 ```
 
 ## Android
diff --git a/src/docs/product/cli/dif.mdx b/src/docs/product/cli/dif.mdx
@@ -50,7 +50,7 @@ to look for them:
 sentry-cli difutil find <identifier>
 ```
 
-Additionally, `sentry-cli upload-dif` can automatically search for files in a
+Additionally, `sentry-cli debug-files upload` can automatically search for files in a
 folder or ZIP archive.
 
 ## Creating Source Bundles
@@ -62,7 +62,7 @@ containing all source files referenced by a specific debug information file.
 
 This is particularly useful when building and uploading debug information files
 are detached. In this case, a source bundle can be created when building and can
-be uploaded at any later point in time with `sentry-cli upload-dif`.
+be uploaded at any later point in time with `sentry-cli debug-files upload`.
 
 To create a source bundle, use the `difutil bundle-sources` command on a list of
 debug information files:
@@ -72,23 +72,23 @@ debug information files:
 sentry-cli difutil bundle-sources /path/to/files...
 
 # at any later time:
-sentry-cli upload-dif --type sourcebundle /path/to/bundles...
+sentry-cli debug-files upload --type sourcebundle /path/to/bundles...
 ```
 
 To create multiple source bundles for all debug information files, use the
 command on each file individually.
 
-Alternatively, add the `--include-sources` option to the `upload-dif` command,
+Alternatively, add the `--include-sources` option to the `debug-files upload` command,
 which generates source bundles on the fly during the upload. This requires that
 the upload is performed on the same machine as the application build:
 
 ```bash
-sentry-cli upload-dif --include-sources /path/to/files...
+sentry-cli debug-files upload --include-sources /path/to/files...
 ```
 
 ## Uploading Files
 
-Use the `sentry-cli upload-dif` command to upload debug information files to
+Use the `sentry-cli debug-files upload` command to upload debug information files to
 Sentry. The command will recursively scan the provided folders or ZIP archives.
 Files that have already been upload are skipped automatically.
 
@@ -108,7 +108,7 @@ to [Working with Projects](/product/cli/configuration/#sentry-cli-working-with-p
 A basic debug file upload can be started with:
 
 ```bash
-sentry-cli upload-dif -o <org> -p <project> /path/to/files...
+sentry-cli debug-files upload -o <org> -p <project> /path/to/files...
 
 > Found 2 debug information files
 > Prepared debug information files for upload
@@ -126,7 +126,7 @@ specify `--wait` in the CLI, which will block until server-side analysis is
 complete:
 
 ```bash
-sentry-cli upload-dif -o <org> -p <project> --wait /path/to/files...
+sentry-cli debug-files upload -o <org> -p <project> --wait /path/to/files...
 
 > Found 2 debug information files
 > Prepared debug information files for upload
@@ -143,7 +143,7 @@ There are a few options you can supply to the upload command:
 
 `--wait`
 
-: Wait for server-side processing of uploaded files. By default, `upload-dif`
+: Wait for server-side processing of uploaded files. By default, `debug-files upload`
 completes once the debug files have been uploaded to Sentry. After this,
 Sentry analyzes the files and makes them available for symbolication. It makes
 sense to specify `--wait` to ensure that debug files are ready before sending
@@ -223,7 +223,7 @@ many useful symbols. In that case, the sentry-cli upload will warn you that it
 needs BCSymbolMaps:
 
 ```bash
-sentry-cli upload-dif ...
+sentry-cli debug-files upload ...
 > Found 34 debug information files
 > Warning: Found 10 symbol files with hidden symbols (need BCSymbolMaps)
 ```
@@ -233,7 +233,7 @@ are generated by the Xcode build process. Supply the `--symbol-maps` parameter
 and point it to the folder containing the symbol maps:
 
 ```bash
-sentry-cli upload-dif --symbol-maps path/to/symbolmaps path/to/debug/symbols
+sentry-cli debug-files upload --symbol-maps path/to/symbolmaps path/to/debug/symbols
 ```
 
 ### Breakpad Files
diff --git a/src/platform-includes/debug-files/android.mdx b/src/platform-includes/debug-files/android.mdx
@@ -0,0 +1,4 @@
+```bash
+sentry-cli login
+sentry-cli debug-files upload -o {YOUR ORGANISATION} -p {PROJECT} build/intermediates/merged_native_libs/{buildVariant}
+```
diff --git a/src/platform-includes/debug-files/dotnet.mdx b/src/platform-includes/debug-files/dotnet.mdx
@@ -0,0 +1,4 @@
+```bash
+sentry-cli login
+sentry-cli debug-files upload -o {YOUR ORGANISATION} -p {PROJECT} bin/Release
+```
diff --git a/src/platform-includes/debug-files/native.mdx b/src/platform-includes/debug-files/native.mdx
@@ -1,5 +1,5 @@
 ```bash
-sentry-cli upload-dif -o <org> -p <project> /path/to/myfile.debug.wasm
+sentry-cli debug-files upload -o <org> -p <project> /path/to/myfile.debug.wasm
 
 > Found 2 debug information files
 > Prepared debug information files for upload
diff --git a/src/platform-includes/debug-files/native.wasm.mdx b/src/platform-includes/debug-files/native.wasm.mdx
@@ -1,6 +1,6 @@
 ```bash
 wasm-split /path/to/myfile.wasm -d /path/to/myfile.debug.wasm --strip
-sentry-cli upload-dif -o <org> -p <project> /path/to/files
+sentry-cli debug-files upload -o <org> -p <project> /path/to/files
 
 > Found 1 debug information files
 > Prepared debug information files for upload
diff --git a/src/platform-includes/debug-symbols-apple/_default.mdx b/src/platform-includes/debug-symbols-apple/_default.mdx
@@ -20,12 +20,12 @@ If this is your situation, please read [Info.plist Is Missing in Xcode 13 — He
 
 ## Sentry-cli
 
-Use the `sentry-cli upload-dif` command to upload dSYMs to Sentry. The command will recursively scan the provided folders or ZIP archives. Files that have already been uploaded will be skipped automatically.
+Use the `sentry-cli debug-files upload` command to upload dSYMs to Sentry. The command will recursively scan the provided folders or ZIP archives. Files that have already been uploaded will be skipped automatically.
 
 Sentry can display snippets of your code next to the event stacktraces. This feature is called <PlatformLink to="/data-management/debug-files/source-context/">source context</PlatformLink>. When setting the `--include-sources` option, sentry-cli will scan your debug files to find references to the source code files, resolve them in the local file system, bundle them up, and upload them to Sentry.
 
 ```bash
-sentry-cli upload-dif --auth-token YOUR_AUTH_TOKEN \
+sentry-cli debug-files upload --auth-token YOUR_AUTH_TOKEN \
   --org ___ORG_SLUG___ \
   --project ___PROJECT_SLUG___ \
   PATH_TO_DSYMS
@@ -68,7 +68,7 @@ Follow these steps to upload the debug symbols:
 1.  Download and install [sentry-cli](/product/cli/installation/).
 2.  Copy the script below into a new _Run Script_ and set your _AUTH_TOKEN_, _ORG_SLUG_, and _PROJECT_SLUG_.
 
-Sentry can display snippets of your code next to the event stacktraces. This feature is called <PlatformLink to="/data-management/debug-files/source-context/">source context</PlatformLink>. When setting the `--include-sources` option, sentry-cli will scan your debug files to find references to the source code files, resolve them in the local file system, bundle them up, and upload them to Sentry. Simply change `sentry-cli upload-dif` to `sentry-cli upload-dif --include-sources` in the copied script.
+Sentry can display snippets of your code next to the event stacktraces. This feature is called <PlatformLink to="/data-management/debug-files/source-context/">source context</PlatformLink>. When setting the `--include-sources` option, sentry-cli will scan your debug files to find references to the source code files, resolve them in the local file system, bundle them up, and upload them to Sentry. Simply change `sentry-cli debug-files upload` to `sentry-cli debug-files upload --include-sources` in the copied script.
 
 <Alert level="" title="Warnings vs. Errors">
 
@@ -83,7 +83,7 @@ if which sentry-cli >/dev/null; then
 export SENTRY_ORG=___ORG_SLUG___
 export SENTRY_PROJECT=___PROJECT_SLUG___
 export SENTRY_AUTH_TOKEN=YOUR_AUTH_TOKEN
-ERROR=$(sentry-cli upload-dif "$DWARF_DSYM_FOLDER_PATH" 2>&1 >/dev/null)
+ERROR=$(sentry-cli debug-files upload "$DWARF_DSYM_FOLDER_PATH" 2>&1 >/dev/null)
 if [ ! $? -eq 0 ]; then
 echo "warning: sentry-cli - $ERROR"
 fi
@@ -97,7 +97,7 @@ if which sentry-cli >/dev/null; then
 export SENTRY_ORG=___ORG_SLUG___
 export SENTRY_PROJECT=___PROJECT_SLUG___
 export SENTRY_AUTH_TOKEN=YOUR_AUTH_TOKEN
-ERROR=$(sentry-cli upload-dif "$DWARF_DSYM_FOLDER_PATH" --force-foreground 2>&1 >/dev/null)
+ERROR=$(sentry-cli debug-files upload "$DWARF_DSYM_FOLDER_PATH" --force-foreground 2>&1 >/dev/null)
 if [ ! $? -eq 0 ]; then
 echo "error: sentry-cli - $ERROR"
 fi
@@ -187,4 +187,4 @@ If you’re using Xcode 13, you’ll need to download the dSYMs from App Store C
   - Click the build number to go into the "detail" page, and click _Download dSYM_.
   - Manually upload the dSYMs with [sentry-cli](#sentry-cli).
 
-These dSYMs contain obfuscated symbol names and paths. You must upload the BCSymbolMap file stored in your xcarchive so Sentry can properly symbolicate your crash reports. You can do this by using the upload-dif command of either [sentry-cli](#sentry-cli) or the [Sentry Fastlane plugin](#fastlane), which will automatically find and upload all BCSymbolMap files when specifying the path to the app's xcarchive.
+These dSYMs contain obfuscated symbol names and paths. You must upload the BCSymbolMap file stored in your xcarchive so Sentry can properly symbolicate your crash reports. You can do this by using the `debug-files upload` command of either [sentry-cli](#sentry-cli) or the [Sentry Fastlane plugin](#fastlane), which will automatically find and upload all BCSymbolMap files when specifying the path to the app's xcarchive.
diff --git a/src/platform-includes/upload-dif/android.mdx b/src/platform-includes/upload-dif/android.mdx
diff --git a/src/platform-includes/upload-dif/dotnet.mdx b/src/platform-includes/upload-dif/dotnet.mdx
diff --git a/src/platforms/common/data-management/debug-files/upload/index.mdx b/src/platforms/common/data-management/debug-files/upload/index.mdx
@@ -39,9 +39,9 @@ The remaining information on this page describes invoking the Sentry CLI manuall
 </Note>
 </PlatformSection>
 
-<PlatformContent includePath="upload-dif">
+<PlatformContent includePath="debug-files">
 
-Files can be uploaded using the `upload-dif` command. This command will scan a
+Files can be uploaded using the `debug-files upload` command. This command will scan a
 given folder recursively for files and upload them to Sentry:
 
 </PlatformContent>
@@ -51,7 +51,7 @@ Information_](/product/cli/dif/#uploading-files).
 
 Debug files should be uploaded before deploying or releasing your
 application so that crash reports can be processed. For manual testing, use the
-`sentry-cli upload-dif --wait` before sending the first native crash or error
+`sentry-cli debug-files upload --wait` before sending the first native crash or error
 event.
 
 If you upload a file that was previously reported as missing by Sentry in a crash
diff --git a/src/platforms/javascript/guides/cordova/upload-debug.mdx b/src/platforms/javascript/guides/cordova/upload-debug.mdx
@@ -33,6 +33,6 @@ if [ ! -f $SENTRY_PROPERTIES ]; then
 fi
 echo "# Reading property from $SENTRY_PROPERTIES"
 SENTRY_CLI=$(getProperty "cli.executable")
-SENTRY_COMMAND="$SENTRY_CLI upload-dif \"$DWARF_DSYM_FOLDER_PATH\""
+SENTRY_COMMAND="$SENTRY_CLI debug-files upload \"$DWARF_DSYM_FOLDER_PATH\""
 $SENTRY_COMMAND
 ```
diff --git a/src/platforms/react-native/upload-debug.mdx b/src/platforms/react-native/upload-debug.mdx
@@ -18,4 +18,4 @@ Upload the [Android ProGuard/R8 mapping files and native symbols](/platforms/and
 
 ## Uploading With sentry-cli
 
-Upload the [Android ProGuard/R8 mapping files and native symbols](/product/cli/) manually by using `sentry-cli` [upload-proguard](/product/cli/dif/#proguard-mapping-upload) and [upload-dif](/product/cli/dif/#uploading-files).
+Upload the [Android ProGuard/R8 mapping files and native symbols](/product/cli/) manually by using `sentry-cli` [upload-proguard](/product/cli/dif/#proguard-mapping-upload) and [debug-files](/product/cli/dif/#uploading-files).
diff --git a/src/platforms/unity/native-support/index.mdx b/src/platforms/unity/native-support/index.mdx
@@ -68,5 +68,5 @@ With `bitcode` disabled, the automated symbols upload will pick up the `dSYM` fi
 If you don't want to rely on the automated symbol upload, you can run `sentry-cli` through the commandline. For that, you can use the provided executables from within the package or follow the [sentry-cli documentation](/product/cli/installation/) to make it available globally. To upload debug symbols, run it with:
 
 ```bash
-sentry-cli --auth-token YOUR_AUTH_TOKEN upload-dif --org ___ORG_SLUG___ --project ___PROJECT_SLUG___ PATH_TO_SYMBOLS
+sentry-cli --auth-token YOUR_AUTH_TOKEN debug-files upload --org ___ORG_SLUG___ --project ___PROJECT_SLUG___ PATH_TO_SYMBOLS
 ```
diff --git a/src/platforms/unreal/debug-symbols.mdx b/src/platforms/unreal/debug-symbols.mdx
@@ -20,5 +20,5 @@ The automated debug symbols upload is disabled by default and requires configura
 To upload debug symbols to Sentry manually, run `sentry-cli` through the command line. You can either use the provided executables from within the package, or follow the [sentry-cli documentation](/product/cli/installation/) to make it available globally. To upload debug symbols run the following command:
 
 ```bash
-sentry-cli --auth-token YOUR_AUTH_TOKEN upload-dif --org ___ORG_SLUG___ --project ___PROJECT_SLUG___ PATH_TO_SYMBOLS
+sentry-cli --auth-token YOUR_AUTH_TOKEN debug-files upload --org ___ORG_SLUG___ --project ___PROJECT_SLUG___ PATH_TO_SYMBOLS
 ```

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +```bash
 +sentry-cli login
 +sentry-cli debug-files upload -o {YOUR ORGANISATION} -p {PROJECT} build/intermediates/merged_native_libs/{buildVariant}
 +```
Original file line number	Diff line number	Diff line change
`@@ -18,4 +18,4 @@ Upload the [Android ProGuard/R8 mapping files and native symbols](/platforms/and`
`18`	`18`
`19`	`19`	`## Uploading With sentry-cli`
`20`	`20`
`21`		-Upload the [Android ProGuard/R8 mapping files and native symbols](/product/cli/) manually by using `sentry-cli` [upload-proguard](/product/cli/dif/#proguard-mapping-upload) and [upload-dif](/product/cli/dif/#uploading-files).
	`21`	+Upload the [Android ProGuard/R8 mapping files and native symbols](/product/cli/) manually by using `sentry-cli` [upload-proguard](/product/cli/dif/#proguard-mapping-upload) and [debug-files](/product/cli/dif/#uploading-files).