Skip to content

Commit 10ea511

Browse files
docs(android): Highlight that our SDK compose dependency is required for the Kotlin Compiler plugin (#12741)
* docs(android): Highlight that our SDK compose dependency is required for the Kotlin Compiler plugin * Update docs/platforms/android/enhance-errors/kotlin-compiler-plugin.mdx Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> * Update docs/platforms/android/enhance-errors/kotlin-compiler-plugin.mdx Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> --------- Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
1 parent 3900434 commit 10ea511

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/platforms/android/enhance-errors/kotlin-compiler-plugin.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ fun LoginScreen() {
4141

4242
## Setup
4343

44-
### Install
44+
### Install the Compiler Plugin
4545

4646
Kotlin Compiler plugins are executed during compilation and thus need to be applied to _every_ relevant Gradle module. Add the following to e.g. your `app/build.gradle`:
4747

@@ -57,6 +57,14 @@ plugins {
5757
}
5858
```
5959

60+
### Add the Runtime Dependency
61+
62+
The runtime dependency is required as well, otherwise the Compiler Plugin will not be able to apply any changes. Add the following to _every_ relevant `build.gradle` module. If you are using the Sentry Android Gradle Plugin, this is already done for you for the `app` module.
63+
64+
```kotlin {filename:app/build.gradle.kts}
65+
implementation("io.sentry:sentry-compose-android:{{@inject packages.version('sentry.java.android', '8.1.0') }}")
66+
```
67+
6068
### Configuration
6169

6270
As of now no additional steps are necessary. Checkout the docs for <PlatformLink to="/enriching-events/viewhierarchy">View Hierarchy</PlatformLink> and <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#user-interaction-instrumentation">User Interaction Tracing</PlatformLink> to see which features the Sentry Kotlin Compiler Plugin improves.

0 commit comments

Comments
 (0)