feat: add plugin support

.craft.yml

@@ -2,6 +2,7 @@ minVersion: 1.2.1
 changelogPolicy: auto
 targets:
   - name: maven
+    id: kmp
     gradleCliPath: ./gradlew
     mavenCliPath: scripts/mvnw
     mavenSettingsPath: scripts/settings.xml
@@ -14,8 +15,19 @@ targets:
     kmp:
       rootDistDirRegex: /^(?!.*(?:jvm|android|ios|watchos|tvos|macos)).*$/
       appleDistDirRegex: /(ios|watchos|tvos|macos)/
+    excludeNames: /sentry-kotlin-multiplatform-gradle-plugin.*$/
+  - name: maven
+    id: plugin
+    gradleCliPath: ./gradlew
+    mavenCliPath: scripts/mvnw
+    mavenSettingsPath: scripts/settings.xml
+    mavenRepoId: ossrh
+    mavenRepoUrl: https://oss.sonatype.org/service/local/staging/deploy/maven2/
+    android: false
+    includeNames: /sentry-kotlin-multiplatform-gradle-plugin.*$/
   - name: github
   - name: registry
     sdks:
       maven:io.sentry:sentry-kotlin-multiplatform:
+#      maven:io.sentry:sentry-kotlin-multiplatform-gradle-plugin:
 

.github/workflows/analyze.yml

@@ -26,4 +26,5 @@ jobs:
           distribution: temurin
 
       - name: Analyze
-        run: ./gradlew apiCheck detekt
+        run:
+          ./gradlew apiCheck detekt spotlessCheck

.github/workflows/kotlin-multiplatform-gradle-plugin.yml

@@ -0,0 +1,65 @@
+name: "Plugin: sentry-kotlin-multiplatform"
+on:
+  push:
+    branches:
+      - main
+      - release/**
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: macos-latest-xlarge
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: JDK setup
+        uses: actions/setup-java@v3
+        with:
+          java-version: 17
+          distribution: temurin
+
+      - name: Cached Konan
+        uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7 #v3
+        with:
+          path: ~/.konan
+          key: ${{ runner.os }}-konan-${{ hashFiles('**/*.gradle*') }}-${{ hashFiles('**/gradle/wrapper/gradle-wrapper.properties') }}
+          restore-keys: ${{ runner.os }}-konan-
+
+      - name: Cached Gradle
+        uses: gradle/gradle-build-action@842c587ad8aa4c68eeba24c396e15af4c2e9f30a
+
+      - name: Build
+        run: |
+          cd sentry-kotlin-multiplatform-gradle-plugin && ./gradlew build
+
+  archive-distribution:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: JDK setup
+        uses: actions/setup-java@v3
+        with:
+          java-version: 17
+          distribution: temurin
+
+      - name: Cached Gradle
+        uses: gradle/gradle-build-action@842c587ad8aa4c68eeba24c396e15af4c2e9f30a
+
+      - name: DistZip
+        run: |
+          cd sentry-kotlin-multiplatform-gradle-plugin && ./gradlew distZip
+
+      - name: Archive packages
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ github.sha }}
+          if-no-files-found: error
+          path: |
+            ./*/build/distributions/*.zip

.run/iosApp-spm.run.xml

@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="iosApp-spm" type="KmmRunConfiguration" factoryName="iOS Application" CONFIG_VERSION="1" EXEC_TARGET_ID="27607109-90E2-4A98-8165-C0FF206F6E6D" XCODE_PROJECT="$PROJECT_DIR$/sentry-samples/kmp-app-spm/iosApp.xcodeproj" XCODE_CONFIGURATION="Debug" XCODE_SCHEME="iosApp">
+  <configuration default="false" name="iosApp-spm" type="KmmRunConfiguration" factoryName="iOS Application" CONFIG_VERSION="1" EXEC_TARGET_ID="EA7F395B-4B34-4EEA-8D00-85297FF4E3BD" XCODE_PROJECT="$PROJECT_DIR$/sentry-samples/kmp-app-spm/iosApp.xcodeproj" XCODE_CONFIGURATION="Debug" XCODE_SCHEME="iosApp">
     <method v="2">
       <option name="com.jetbrains.kmm.ios.BuildIOSAppTask" enabled="true" />
     </method>

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## Unreleased
 
+### Features
+
+- New Sentry KMP Gradle plugin ([#230](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/230))
+  - Install via `plugins { id("io.sentry.kotlin.multiplatform.gradle") version "{version}" }`  
+  - Enables auto installing of the KMP SDK to commonMain (if all targets are supported)
+  - Enables auto installing of the required Sentry Cocoa SDK with Cocoapods (if Cocoapods plugin is enabled)
+  - Configures linking for SPM (both dynamic and static frameworks)
+
 ### Dependencies
 
 - Bump Java SDK from v7.9.0 to v7.12.0 ([#236](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/236), [#242](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/242))

build.gradle.kts

@@ -72,10 +72,12 @@ spotless {
 
     kotlin {
         target("**/*.kt")
+        targetExclude("**/generated/**/*.kt")
         ktlint()
     }
     kotlinGradle {
         target("**/*.kts")
+        targetExclude("**/generated/**/*.kts")
         ktlint()
     }
 }
@@ -115,3 +117,8 @@ val detektProjectBaseline by tasks.registering(io.gitlab.arturbosch.detekt.Detek
     include("**/*.kt")
     detektExcludes()
 }
+
+// Configure tasks so it is also run for the plugin
+tasks.getByName("detekt") {
+    gradle.includedBuild("sentry-kotlin-multiplatform-gradle-plugin").task(":detekt")
+}

buildSrc/src/main/java/Config.kt

@@ -1,7 +1,7 @@
 object Config {
     val agpVersion = "7.4.2"
-    val kotlinVersion = "1.9.21"
-    val composeVersion = "1.5.11"
+    val kotlinVersion = "1.9.23"
+    val composeVersion = "1.6.1"
     val gradleMavenPublishPluginVersion = "0.18.0"
 
     val multiplatform = "multiplatform"

scripts/bump-version.sh

@@ -12,7 +12,9 @@ OLD_VERSION="$1"
 NEW_VERSION="$2"
 
 GRADLE_FILEPATH="gradle.properties"
+PLUGIN_GRADLE_FILEPATH="sentry-kotlin-multiplatform-gradle-plugin/gradle.properties"
 
 # Replace `versionName` with the given version
 VERSION_NAME_PATTERN="versionName"
 perl -pi -e "s/$VERSION_NAME_PATTERN=.*$/$VERSION_NAME_PATTERN=$NEW_VERSION/g" $GRADLE_FILEPATH
+perl -pi -e "s/$VERSION_NAME_PATTERN=.*$/$VERSION_NAME_PATTERN=$NEW_VERSION/g" $PLUGIN_GRADLE_FILEPATH

sentry-kotlin-multiplatform-gradle-plugin/build.gradle.kts

@@ -0,0 +1,93 @@
+import com.vanniktech.maven.publish.MavenPublishPluginExtension
+import io.gitlab.arturbosch.detekt.Detekt
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+plugins {
+    alias(libs.plugins.kotlin)
+    alias(libs.plugins.detekt)
+    `java-gradle-plugin`
+    alias(libs.plugins.vanniktech.publish)
+    id("distribution")
+    alias(libs.plugins.buildConfig)
+}
+
+version = property("versionName").toString()
+
+group = property("group").toString()
+
+dependencies {
+    compileOnly(kotlin("stdlib"))
+    compileOnly(gradleApi())
+    compileOnly(kotlin("gradle-plugin"))
+
+    testImplementation(kotlin("gradle-plugin"))
+    testImplementation(libs.junit)
+}
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
+}
+
+tasks.withType<KotlinCompile> { kotlinOptions { jvmTarget = JavaVersion.VERSION_1_8.toString() } }
+
+gradlePlugin {
+    plugins {
+        create(property("id").toString()) {
+            id = property("id").toString()
+            implementationClass = property("implementationClass").toString()
+        }
+    }
+}
+
+val publish = extensions.getByType(MavenPublishPluginExtension::class.java)
+// signing is done when uploading files to MC
+// via gpg:sign-and-deploy-file (release.kts)
+publish.releaseSigningEnabled = false
+
+tasks.named("distZip").configure {
+    dependsOn("publishToMavenLocal")
+    this.doLast {
+        val distributionFilePath =
+            "${project.layout.buildDirectory.asFile.get().path}${sep}distributions${sep}${project.name}-${project.version}.zip"
+        val file = File(distributionFilePath)
+        if (!file.exists()) {
+            throw IllegalStateException("Distribution file: $distributionFilePath does not exist")
+        }
+        if (file.length() == 0L) {
+            throw IllegalStateException("Distribution file: $distributionFilePath is empty")
+        }
+    }
+}
+
+val sep = File.separator
+
+distributions {
+    main {
+        contents {
+            from("build${sep}libs")
+            from("build${sep}publications${sep}maven")
+        }
+    }
+}
+
+buildConfig {
+    useKotlinOutput()
+    packageName("io.sentry")
+    className("BuildConfig")
+
+    buildConfigField(
+        "String",
+        "SentryCocoaVersion",
+        provider { "\"${project.property("sentryCocoaVersion")}\"" }
+    )
+}
+
+detekt { config.setFrom(rootProject.files("../config/detekt/detekt.yml")) }
+
+tasks.withType<Detekt>().configureEach {
+    reports {
+        html.required.set(true)
+        html.outputLocation.set(file("build/reports/detekt.html"))
+    }
+}

sentry-kotlin-multiplatform-gradle-plugin/gradle.properties

@@ -0,0 +1,6 @@
+id=io.sentry.kotlin.multiplatform.gradle
+implementationClass=io.sentry.kotlin.multiplatform.gradle.SentryPlugin
+versionName=0.7.1
+group=io.sentry
+# TODO: Update update-cocoa.sh so the cocoa version is auto updated as well
+sentryCocoaVersion=8.26.0

sentry-kotlin-multiplatform-gradle-plugin/gradle/libs.versions.toml

@@ -0,0 +1,16 @@
+[versions]
+detekt = "1.23.6"
+kotlin = "1.9.23"
+pluginPublish = "1.2.1"
+buildConfig = "5.3.5"
+vanniktechPublish = "0.18.0"
+
+[plugins]
+detekt = { id = "io.gitlab.arturbosch.detekt", version.ref = "detekt"}
+kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin"}
+pluginPublish = { id = "com.gradle.plugin-publish", version.ref = "pluginPublish"}
+vanniktech-publish = { id = "com.vanniktech.maven.publish", version.ref = "vanniktechPublish"}
+buildConfig = { id = "com.github.gmazzo.buildconfig", version.ref = "buildConfig"}
+
+[libraries]
+junit = "junit:junit:4.13.2"

sentry-kotlin-multiplatform-gradle-plugin/gradle/wrapper

@@ -0,0 +1 @@
+../../gradle/wrapper/

sentry-kotlin-multiplatform-gradle-plugin/gradlew

@@ -0,0 +1 @@
+../gradlew

sentry-kotlin-multiplatform-gradle-plugin/gradlew.bat

@@ -0,0 +1 @@
+../gradlew.bat

sentry-kotlin-multiplatform-gradle-plugin/settings.gradle.kts

@@ -0,0 +1,15 @@
+pluginManagement {
+    repositories {
+        gradlePluginPortal()
+        mavenCentral()
+    }
+}
+
+dependencyResolutionManagement {
+    repositories {
+        google()
+        mavenCentral()
+    }
+}
+
+rootProject.name = "sentry-kotlin-multiplatform-gradle-plugin"

sentry-kotlin-multiplatform-gradle-plugin/src/main/java/io/sentry/kotlin/multiplatform/gradle/AutoInstallExtension.kt

@@ -0,0 +1,26 @@
+package io.sentry.kotlin.multiplatform.gradle
+
+import org.gradle.api.Project
+import org.gradle.api.provider.Property
+import javax.inject.Inject
+
+@Suppress("UnnecessaryAbstractClass")
+abstract class AutoInstallExtension @Inject constructor(project: Project) {
+    private val objects = project.objects
+
+    /**
+     * Enable auto-installation of the Sentry dependencies through [CocoapodsAutoInstallExtension]
+     * and [SourceSetAutoInstallExtension].
+     *
+     * Disabling this will prevent the plugin from auto installing any dependency.
+     *
+     * Defaults to true.
+     */
+    val enabled: Property<Boolean> = objects.property(Boolean::class.java).convention(true)
+
+    val cocoapods: CocoapodsAutoInstallExtension =
+        objects.newInstance(CocoapodsAutoInstallExtension::class.java, project)
+
+    val commonMain: SourceSetAutoInstallExtension =
+        objects.newInstance(SourceSetAutoInstallExtension::class.java, project)
+}

sentry-kotlin-multiplatform-gradle-plugin/src/main/java/io/sentry/kotlin/multiplatform/gradle/CocoapodsAutoInstallExtension.kt

@@ -0,0 +1,29 @@
+package io.sentry.kotlin.multiplatform.gradle
+
+import io.sentry.BuildConfig
+import org.gradle.api.Project
+import org.gradle.api.provider.Property
+import javax.inject.Inject
+
+@Suppress("UnnecessaryAbstractClass")
+abstract class CocoapodsAutoInstallExtension @Inject constructor(project: Project) {
+    private val objects = project.objects
+
+    /**
+     * Enable auto-installation of the Sentry Cocoa SDK pod.
+     *
+     * If the cocoapods plugin is applied and no existing Sentry pod configuration exists, the
+     * Sentry-Cocoa SDK pod will be installed.
+     *
+     * Defaults to true.
+     */
+    val enabled: Property<Boolean> = objects.property(Boolean::class.java).convention(true)
+
+    /**
+     * Overrides default Sentry Cocoa version.
+     *
+     * Defaults to the version used in the latest KMP SDK.
+     */
+    val sentryCocoaVersion: Property<String> =
+        objects.property(String::class.java).convention("~> ${BuildConfig.SentryCocoaVersion}")
+}