Skip to content

Commit

Permalink
docs(flutter): Update sentry dart plugin docs (#10354)
Browse files Browse the repository at this point in the history
* Update sentry dart plugin docs

* Add missing properies

* incorp pr feedback
  • Loading branch information
denrase authored Jun 24, 2024
1 parent 1e668cf commit f96fe57
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion docs/platforms/flutter/upload-debug.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ sentry:
wait_for_processing: false
log_level: error
release: ...
dist: ...
web_build_path: ...
commits: auto
ignore_missing: true
Expand Down Expand Up @@ -106,7 +107,13 @@ Configures the log level for sentry-cli. This is a `string` type with default va

`release`

The release version for source maps, it should match the release set by the SDK. This is a `string` type with default value `name@version` from pubspec. The alternative environmental variable is `SENTRY_RELEASE`.
The release version for source maps, which should match the release set by the SDK. This is a `string` type with default value `name@version` from pubspec. If a build number is included in the version, it is utilized as dist. The alternative environmental variable is `SENTRY_RELEASE`.

Setting a custom release can be specified via an environment variable or plugin configuration. Once set, it is used as is without further modification.

`dist`

Custom dist can also be set via the environment variable `SENTRY_DIST` or via plugin configuration. It replaces or adds to the build number in the default release.

`web_build_path`

Expand All @@ -120,6 +127,18 @@ Release commits integration. This is a `string` type with default value `auto`.

Ignore missing commits previously used in the release. This is a boolean type with default value `false`.

`bin_dir`

The folder where the plugin downloads the sentry-cli binary. This is a `string` type with default value `.dart_tool/pub/bin/sentry_dart_plugin`.

`bin_path`

Path to the sentry-cli binary to use instead of downloading. Make sure to use the correct version. This is a `string` type and is empty by default.

`sentry_cli_cdn_url`

Alternative place to download sentry-cli. This is a `string` type with default value `https://downloads.sentry-cdn.com/sentry-cli`. Alternatively, this can also be set with the `SENTRYCLI_CDNURL` environment variable.

### Run

```bash
Expand Down

0 comments on commit f96fe57

Please sign in to comment.