From 0a3437825284e318a50484f79bbb1779d87a5060 Mon Sep 17 00:00:00 2001 From: fiveable-jferg <88333913+fiveable-jferg@users.noreply.github.com> Date: Thu, 21 Apr 2022 21:51:49 -0500 Subject: [PATCH] Update dryRun documentation to reflect auto-configuration. It took me far too long to figure out how dryRun was getting set to true when running a local Next.JS development environment, and I don't see this behavior explicitly documented anywhere. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bc8d175d..3e53b961 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ Also, check the [example](example) directory. | 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`. | | 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` | | finalize | `boolean` | optional | Determines whether Sentry release record should be automatically finalized (`date_released` timestamp added) after artifact upload. Defaults to `true` | -| dryRun | `boolean` | optional | Attempts a dry run (useful for dev environments). Defaults to `false`. | +| dryRun | `boolean` | optional | Attempts a dry run (useful for dev environments). Defaults to `false`, but may be automatically set to true in development environments by some framework integrations (Next.JS, possibly others). | | debug | `boolean` | optional | Print useful debug information. Defaults to `false`. | | silent | `boolean` | optional | Suppresses all logs (useful for `--json` option). Defaults to `false`. | | cleanArtifacts | `boolean` | optional | Remove all the artifacts in the release before the upload. Defaults to `false`. |