From 73e021dc8c5e0a87bc1f9d4a900e5b11d4ab4453 Mon Sep 17 00:00:00 2001 From: GIancarlo Buenaflor Date: Wed, 9 Oct 2024 17:22:34 +0200 Subject: [PATCH 1/9] update --- .craft.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.craft.yml b/.craft.yml index 900ba86a..37c6b973 100644 --- a/.craft.yml +++ b/.craft.yml @@ -10,7 +10,7 @@ targets: mavenRepoUrl: https://oss.sonatype.org/service/local/staging/deploy/maven2/ android: distDirRegex: /^(sentry-android-|.*-android).*$/ - fileReplaceeRegex: /\d\.\d\.\d(-\w+(\.\d)?)?(-SNAPSHOT)?/ + fileReplaceeRegex: /\d+\.\d+\.\d+(-\w+(\.\d)?)?(-SNAPSHOT)?/ fileReplacerStr: release.aar kmp: rootDistDirRegex: /^(?!.*(?:jvm|android|ios|watchos|tvos|macos)).*$/ From ff7660c50ea0ecaec32ae3bcbe5a79020304b0c6 Mon Sep 17 00:00:00 2001 From: GIancarlo Buenaflor Date: Wed, 9 Oct 2024 17:35:16 +0200 Subject: [PATCH 2/9] update --- build.gradle.kts | 99 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 98 insertions(+), 1 deletion(-) diff --git a/build.gradle.kts b/build.gradle.kts index 7a15ad86..c3ce14ae 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -2,6 +2,7 @@ import com.diffplug.spotless.LineEnding import com.vanniktech.maven.publish.MavenPublishPlugin import com.vanniktech.maven.publish.MavenPublishPluginExtension import io.gitlab.arturbosch.detekt.Detekt +import java.util.zip.ZipFile plugins { id(Config.gradleMavenPublishPlugin).version(Config.gradleMavenPublishPluginVersion) @@ -15,7 +16,8 @@ plugins { id(Config.BuildPlugins.buildConfig).version(Config.BuildPlugins.buildConfigVersion).apply(false) kotlin(Config.kotlinSerializationPlugin).version(Config.kotlinVersion).apply(false) id(Config.QualityPlugins.kover).version(Config.QualityPlugins.koverVersion).apply(false) - id(Config.QualityPlugins.binaryCompatibility).version(Config.QualityPlugins.binaryCompatibilityVersion).apply(false) + id(Config.QualityPlugins.binaryCompatibility).version(Config.QualityPlugins.binaryCompatibilityVersion) + .apply(false) } allprojects { @@ -61,6 +63,101 @@ subprojects { } } +tasks.register("validateDistributionArtifacts") { + subprojects { + val subproject = this@subprojects + if (subproject.name == "sentry-kotlin-multiplatform") { + validateKotlinMultiplatformCoreArtifacts(subproject) + } + } +} + +private fun validateKotlinMultiplatformCoreArtifacts(project: Project) { + val rootDistributionFilePath = + "${project.layout.buildDirectory.asFile.get().path}${sep}distributions" + val expectedNumOfFiles = 15 + val filesList = File(rootDistributionFilePath).listFiles() + val actualNumberOfFiles = filesList?.size ?: 0 + + if (actualNumberOfFiles == expectedNumOfFiles) { + println("✅ Found $actualNumberOfFiles distribution files as expected.") + } else { + throw IllegalStateException("❌ Expected $expectedNumOfFiles distribution files, but found $actualNumberOfFiles") + } + + val baseFileName = "sentry-kotlin-multiplatform" + val platforms = listOf( + "watchosx64", "watchossimulatorarm64", "watchosarm64", "watchosarm32", + "tvosx64", "tvossimulatorarm64", "tvosarm64", + "macosx64", "macosarm64", + "jvm", + "iosx64", "iossimulatorarm64", "iosarm64", + "android" + ) + val listOfArtifactPaths = buildList { + add("$rootDistributionFilePath$sep$baseFileName-$version.zip") + addAll(platforms.map { platform -> + "$rootDistributionFilePath$sep$baseFileName-$platform-$version.zip" + }) + } + + listOfArtifactPaths.forEach { artifactPath -> + val artifactFile = File(artifactPath) + if (!artifactFile.exists()) { + throw IllegalStateException("❌ Artifact file: $artifactPath does not exist") + } + if (artifactFile.length() == 0L) { + throw IllegalStateException("❌ Artifact file: $artifactPath is empty") + } + + val file = File(artifactPath) + ZipFile(file).use { zip -> + val entries = zip.entries().asSequence().map { it.name }.toList() + val javadocFile = entries.firstOrNull { it.contains("javadoc") } + if (javadocFile == null) { + throw IllegalStateException("❌ javadoc file not found in ${file.name}") + } + val sourcesFile = entries.firstOrNull { it.contains("sources") } + if (sourcesFile == null) { + throw IllegalStateException("❌ sources file not found in ${file.name}") + } + val moduleFile = entries.firstOrNull { it.contains("module") } + if (moduleFile == null) { + throw IllegalStateException("❌ module file not found in ${file.name}") + } + val pomFile = entries.firstOrNull { it.contains("pom-default.xml") } + if (pomFile == null) { + throw IllegalStateException("❌ pom file not found in ${file.name}") + } + + val isAppleArtifact = + file.name.contains("ios") || file.name.contains("macos") || file.name.contains("watchos") || file.name.contains( + "tvos" + ) + if (isAppleArtifact) { + // this is hardcoded but will probably not change unless we add another cinterop library or remove one + val expectedNumOfKlibFiles = 3 + val actualKlibFiles = entries.filter { it.contains("klib") } + if (actualKlibFiles.size != expectedNumOfKlibFiles) { + throw IllegalStateException("❌ $expectedNumOfKlibFiles klib files not found in ${file.name}") + } else { + println("✅ Found $expectedNumOfKlibFiles klib files in ${file.name}") + } + } + + val isAndroidArtifact = file.name.contains("android") + if (isAndroidArtifact) { + val aarFile = entries.firstOrNull() { it.contains("aar") } + if (aarFile == null) { + throw IllegalStateException("❌ aar file not found in ${file.name}") + } else { + println("✅ Found aar file in ${file.name}") + } + } + } + } +} + subprojects { if (project.name.contains("sentry-kotlin-multiplatform")) { apply(plugin = Config.dokka) From a1d6a93bbef4d2c92f81e13252e65fe690ebc589 Mon Sep 17 00:00:00 2001 From: GIancarlo Buenaflor Date: Wed, 9 Oct 2024 17:36:28 +0200 Subject: [PATCH 3/9] update --- .github/workflows/upload-artifacts.yml | 4 ++++ build.gradle.kts | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/upload-artifacts.yml b/.github/workflows/upload-artifacts.yml index 8cf701d1..3e9de9fd 100644 --- a/.github/workflows/upload-artifacts.yml +++ b/.github/workflows/upload-artifacts.yml @@ -33,6 +33,10 @@ jobs: cd sentry-kotlin-multiplatform-gradle-plugin ./gradlew distZip sentryPluginMarkerDistZip + - name: Validate distributions + run: | + ./gradlew validateDistributions + - name: Archive packages uses: actions/upload-artifact@v4 with: diff --git a/build.gradle.kts b/build.gradle.kts index c3ce14ae..cb6196dd 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -63,7 +63,7 @@ subprojects { } } -tasks.register("validateDistributionArtifacts") { +tasks.register("validateDistributions") { subprojects { val subproject = this@subprojects if (subproject.name == "sentry-kotlin-multiplatform") { From cf02e2d7e82a5634457a48ffc155bbc95d75cdd1 Mon Sep 17 00:00:00 2001 From: GIancarlo Buenaflor Date: Wed, 9 Oct 2024 17:38:17 +0200 Subject: [PATCH 4/9] test --- .github/workflows/upload-artifacts.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/upload-artifacts.yml b/.github/workflows/upload-artifacts.yml index 3e9de9fd..a59e5ada 100644 --- a/.github/workflows/upload-artifacts.yml +++ b/.github/workflows/upload-artifacts.yml @@ -1,8 +1,9 @@ name: "Generate and upload distributions" on: push: - branches: - - release/** +# todo: test it in pr +# branches: +# - release/** concurrency: group: ${{ github.workflow }}-${{ github.ref }} From 9db4e04a5656d594c5faa60f8600f46ad90c7fc2 Mon Sep 17 00:00:00 2001 From: GIancarlo Buenaflor Date: Fri, 11 Oct 2024 21:53:28 +0200 Subject: [PATCH 5/9] formatting --- build.gradle.kts | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/build.gradle.kts b/build.gradle.kts index cb6196dd..9b102169 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -96,9 +96,11 @@ private fun validateKotlinMultiplatformCoreArtifacts(project: Project) { ) val listOfArtifactPaths = buildList { add("$rootDistributionFilePath$sep$baseFileName-$version.zip") - addAll(platforms.map { platform -> - "$rootDistributionFilePath$sep$baseFileName-$platform-$version.zip" - }) + addAll( + platforms.map { platform -> + "$rootDistributionFilePath$sep$baseFileName-$platform-$version.zip" + } + ) } listOfArtifactPaths.forEach { artifactPath -> From 8e95e382abe7a7b7ff3214e50a27852ea011b015 Mon Sep 17 00:00:00 2001 From: Giancarlo Buenaflor Date: Mon, 14 Oct 2024 14:56:49 +0200 Subject: [PATCH 6/9] Update upload-artifacts.yml --- .github/workflows/upload-artifacts.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/upload-artifacts.yml b/.github/workflows/upload-artifacts.yml index a59e5ada..8217cf5a 100644 --- a/.github/workflows/upload-artifacts.yml +++ b/.github/workflows/upload-artifacts.yml @@ -1,9 +1,8 @@ name: "Generate and upload distributions" on: push: -# todo: test it in pr -# branches: -# - release/** + branches: + - release/** concurrency: group: ${{ github.workflow }}-${{ github.ref }} From 471eec8a053ba1842904a18a1b475dfe0e0a0767 Mon Sep 17 00:00:00 2001 From: Giancarlo Buenaflor Date: Mon, 14 Oct 2024 14:57:07 +0200 Subject: [PATCH 7/9] Update upload-artifacts.yml --- .github/workflows/upload-artifacts.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/upload-artifacts.yml b/.github/workflows/upload-artifacts.yml index 8217cf5a..3e9de9fd 100644 --- a/.github/workflows/upload-artifacts.yml +++ b/.github/workflows/upload-artifacts.yml @@ -1,8 +1,8 @@ name: "Generate and upload distributions" on: push: - branches: - - release/** + branches: + - release/** concurrency: group: ${{ github.workflow }}-${{ github.ref }} From 5ebfee393c6d84c6a02081f5a17df43976e2d04d Mon Sep 17 00:00:00 2001 From: Giancarlo Buenaflor Date: Mon, 14 Oct 2024 19:55:37 +0200 Subject: [PATCH 8/9] Update .craft.yml --- .craft.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.craft.yml b/.craft.yml index 37c6b973..118af607 100644 --- a/.craft.yml +++ b/.craft.yml @@ -10,7 +10,7 @@ targets: mavenRepoUrl: https://oss.sonatype.org/service/local/staging/deploy/maven2/ android: distDirRegex: /^(sentry-android-|.*-android).*$/ - fileReplaceeRegex: /\d+\.\d+\.\d+(-\w+(\.\d)?)?(-SNAPSHOT)?/ + fileReplaceeRegex: /\d+\.\d+\.\d+(-\w+(\.\d+)?)?(-SNAPSHOT)?/ fileReplacerStr: release.aar kmp: rootDistDirRegex: /^(?!.*(?:jvm|android|ios|watchos|tvos|macos)).*$/ From 655c9eb37dc84d338f388eda42b36db4931213c5 Mon Sep 17 00:00:00 2001 From: GIancarlo Buenaflor Date: Tue, 15 Oct 2024 03:21:16 +0200 Subject: [PATCH 9/9] clean up --- build.gradle.kts | 103 ++++++++++++++++++++++------------------------- 1 file changed, 49 insertions(+), 54 deletions(-) diff --git a/build.gradle.kts b/build.gradle.kts index 9b102169..da79214f 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -41,8 +41,8 @@ subprojects { val distributionFilePath = "${this.project.buildDir}${sep}distributions${sep}${this.project.name}-${this.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") + if (!file.exists()) throw GradleException("Distribution file: $distributionFilePath does not exist") + if (file.length() == 0L) throw GradleException("Distribution file: $distributionFilePath is empty") } } @@ -67,22 +67,21 @@ tasks.register("validateDistributions") { subprojects { val subproject = this@subprojects if (subproject.name == "sentry-kotlin-multiplatform") { - validateKotlinMultiplatformCoreArtifacts(subproject) + subproject.validateKotlinMultiplatformCoreArtifacts() } } } -private fun validateKotlinMultiplatformCoreArtifacts(project: Project) { - val rootDistributionFilePath = - "${project.layout.buildDirectory.asFile.get().path}${sep}distributions" +private fun Project.validateKotlinMultiplatformCoreArtifacts() { + val distributionDir = project.layout.buildDirectory.dir("distributions").get().asFile val expectedNumOfFiles = 15 - val filesList = File(rootDistributionFilePath).listFiles() - val actualNumberOfFiles = filesList?.size ?: 0 + val filesList = distributionDir.listFiles() + val actualNumOfFiles = filesList?.size ?: 0 - if (actualNumberOfFiles == expectedNumOfFiles) { - println("✅ Found $actualNumberOfFiles distribution files as expected.") + if (actualNumOfFiles == expectedNumOfFiles) { + println("✅ Found $actualNumOfFiles distribution files as expected.") } else { - throw IllegalStateException("❌ Expected $expectedNumOfFiles distribution files, but found $actualNumberOfFiles") + throw GradleException("❌ Expected $expectedNumOfFiles distribution files, but found $actualNumOfFiles") } val baseFileName = "sentry-kotlin-multiplatform" @@ -94,66 +93,62 @@ private fun validateKotlinMultiplatformCoreArtifacts(project: Project) { "iosx64", "iossimulatorarm64", "iosarm64", "android" ) - val listOfArtifactPaths = buildList { - add("$rootDistributionFilePath$sep$baseFileName-$version.zip") + + val artifactPaths = buildList { + add(distributionDir.resolve("$baseFileName-$version.zip")) addAll( platforms.map { platform -> - "$rootDistributionFilePath$sep$baseFileName-$platform-$version.zip" + distributionDir.resolve("$baseFileName-$platform-$version.zip") } ) } - listOfArtifactPaths.forEach { artifactPath -> - val artifactFile = File(artifactPath) + val commonRequiredEntries = listOf( + "javadoc", + "sources", + "module", + "pom-default.xml" + ) + + artifactPaths.forEach { artifactFile -> if (!artifactFile.exists()) { - throw IllegalStateException("❌ Artifact file: $artifactPath does not exist") + throw GradleException("❌ Artifact file: ${artifactFile.path} does not exist") } if (artifactFile.length() == 0L) { - throw IllegalStateException("❌ Artifact file: $artifactPath is empty") + throw GradleException("❌ Artifact file: ${artifactFile.path} is empty") } - val file = File(artifactPath) - ZipFile(file).use { zip -> + ZipFile(artifactFile).use { zip -> val entries = zip.entries().asSequence().map { it.name }.toList() - val javadocFile = entries.firstOrNull { it.contains("javadoc") } - if (javadocFile == null) { - throw IllegalStateException("❌ javadoc file not found in ${file.name}") - } - val sourcesFile = entries.firstOrNull { it.contains("sources") } - if (sourcesFile == null) { - throw IllegalStateException("❌ sources file not found in ${file.name}") - } - val moduleFile = entries.firstOrNull { it.contains("module") } - if (moduleFile == null) { - throw IllegalStateException("❌ module file not found in ${file.name}") - } - val pomFile = entries.firstOrNull { it.contains("pom-default.xml") } - if (pomFile == null) { - throw IllegalStateException("❌ pom file not found in ${file.name}") - } - val isAppleArtifact = - file.name.contains("ios") || file.name.contains("macos") || file.name.contains("watchos") || file.name.contains( - "tvos" - ) - if (isAppleArtifact) { - // this is hardcoded but will probably not change unless we add another cinterop library or remove one - val expectedNumOfKlibFiles = 3 - val actualKlibFiles = entries.filter { it.contains("klib") } - if (actualKlibFiles.size != expectedNumOfKlibFiles) { - throw IllegalStateException("❌ $expectedNumOfKlibFiles klib files not found in ${file.name}") + commonRequiredEntries.forEach { requiredEntry -> + if (entries.none { it.contains(requiredEntry) }) { + throw GradleException("❌ $requiredEntry not found in ${artifactFile.name}") } else { - println("✅ Found $expectedNumOfKlibFiles klib files in ${file.name}") + println("✅ Found $requiredEntry in ${artifactFile.name}") } } - val isAndroidArtifact = file.name.contains("android") - if (isAndroidArtifact) { - val aarFile = entries.firstOrNull() { it.contains("aar") } - if (aarFile == null) { - throw IllegalStateException("❌ aar file not found in ${file.name}") - } else { - println("✅ Found aar file in ${file.name}") + when { + artifactFile.name.contains("ios", ignoreCase = true) || + artifactFile.name.contains("macos", ignoreCase = true) || + artifactFile.name.contains("watchos", ignoreCase = true) || + artifactFile.name.contains("tvos", ignoreCase = true) -> { + val expectedNumOfKlibFiles = 3 + val actualKlibFiles = entries.count { it.contains("klib") } + if (actualKlibFiles != expectedNumOfKlibFiles) { + throw GradleException("❌ Expected $expectedNumOfKlibFiles klib files in ${artifactFile.name}, but found $actualKlibFiles") + } else { + println("✅ Found $expectedNumOfKlibFiles klib files in ${artifactFile.name}") + } + } + + artifactFile.name.contains("android", ignoreCase = true) -> { + if (entries.none { it.contains("aar") }) { + throw GradleException("❌ aar file not found in ${artifactFile.name}") + } else { + println("✅ Found aar file in ${artifactFile.name}") + } } } }