Skip to content
This repository was archived by the owner on Nov 20, 2023. It is now read-only.

Commit ea8db20

Browse files
docs: Fix description and default value for sourceMapReferences (#318)
* docs: Fix description and default value for sourceMapReferences * Apply suggestions from code review Co-authored-by: Katie Byers <katie.byers@sentry.io> Co-authored-by: Katie Byers <katie.byers@sentry.io>
1 parent 8531ed2 commit ea8db20

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Also, check the [example](example) directory.
7878
| validate | `boolean` | optional | When `true`, attempts source map validation before upload if rewriting is not enabled. It will spot a variety of issues with source maps and cancel the upload if any are found. Defaults to `false` to prevent false positives canceling upload. |
7979
| stripPrefix | `array` | optional | When paired with `rewrite`, will remove a prefix from filename references inside of sourcemaps. Useful for removing a path that is build-machine-specific. Note that this will NOT change the names of uploaded files. |
8080
| stripCommonPrefix | `boolean` | optional | When paired with `rewrite`, will add `~` to the `stripPrefix` array. Defaults to `false`. |
81-
| sourceMapReference | `boolean` | optional | Prevents the automatic detection of sourcemap references. Defaults to `false`. |
81+
| sourceMapReference | `boolean` | optional | Determines whether sentry-cli should attempt to link minified files with their corresponding maps. By default, it will match files and maps based on name, and add a `Sourcemap` header to each minified file for which it finds a map. Can be disabled if all minified files contain `sourceMappingURL`. Defaults to `true`. |
8282
| rewrite | `boolean` | optional | Enables rewriting of matching source maps so that indexed maps are flattened and missing sources are inlined if possible. Defaults to `true` |
8383
| finalize | `boolean` | optional | Determines whether Sentry release record should be automatically finalized (`date_released` timestamp added) after artifact upload. Defaults to `true` |
8484
| dryRun | `boolean` | optional | Attempts a dry run (useful for dev environments). Defaults to `false`. |

0 commit comments

Comments
 (0)