From 8144de088c140913358f750a32d24f9738ec9d3c Mon Sep 17 00:00:00 2001 From: Matthew Nelson Date: Sun, 1 Dec 2024 10:12:33 -0500 Subject: [PATCH] Prepare 4.8.10-0-1.4.5 release --- CHANGELOG.md | 4 ++ README.md | 53 ++++++++-------- .../src/main/kotlin/kmp/tor/env.kt | 2 +- .../main/kotlin/-KmpConfigurationExtension.kt | 60 +++++++++---------- .../kmp/tor/manager/TorManager.kt | 2 + .../kmp/tor/manager/TorManager.kt | 2 + .../tor/manager/internal/-CommonPlatform.kt | 2 + .../kmp/tor/manager/TorManager.kt | 2 + 8 files changed, 69 insertions(+), 58 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 280e04f8f..1fb4fc814 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # CHANGELOG +## Version 4.8.10-0-1.4.5 (2024-12-01) + - Add deprecation notice to `TorManager` in preparation for `2.0.0` release. + - Disable non-Android & non-Jvm targets + ## Version 4.8.10-0-1.4.4 (2023-12-20) - Updates dependencies - `kmp-tor-binary` -> `4.8.10-0` diff --git a/README.md b/README.md index 25a24517a..f56e46956 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,7 @@ Kotlin Multiplatform support for embedding Tor into your application. -**NOTICE:** `kmp-tor` is being overhauled. This branch is for the `1.x.x` version. See -[HERE][url-kmp-tor-master] for the latest and greatest. +## **NOTICE:** `kmp-tor` version `1.x.x` is `DEPRECATED`. Refer to [master branch][url-kmp-tor-master] ### Get Started @@ -27,7 +26,7 @@ Add dependency dependencies { val vTor = "4.8.10-0" - val vKmpTor = "1.4.4" + val vKmpTor = "1.4.5" implementation("io.matthewnelson.kotlin-components:kmp-tor:$vTor-$vKmpTor") } @@ -39,7 +38,7 @@ dependencies { dependencies { def vTor = '4.8.10-0' - def vKmpTor = '1.4.4' + def vKmpTor = '1.4.5' implementation "io.matthewnelson.kotlin-components:kmp-tor:$vTor-$vKmpTor" } @@ -136,7 +135,7 @@ can express the `TorConfig.Setting.Ports.Control` setting when providing your co dependencies { def vTor = '4.8.10-0' - def vKmpTor = '1.4.4' + def vKmpTor = '1.4.5' implementation "io.matthewnelson.kotlin-components:kmp-tor:$vTor-$vKmpTor" // Add the callback extension @@ -221,7 +220,7 @@ public class Example2 { -[badge-latest-release]: https://img.shields.io/badge/latest--release-4.8.10--0--1.4.4-5d2f68.svg?logo=torproject&style=flat&logoColor=5d2f68 +[badge-latest-release]: https://img.shields.io/badge/latest--release-2.0.0--alpha01-5d2f68.svg?logo=torproject&style=flat&logoColor=5d2f68 [badge-license]: https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat @@ -233,19 +232,19 @@ public class Example2 { [badge-kmp-tor-binary]: https://img.shields.io/badge/kmp--tor--binary-4.8.10--0-5d2f68.svg?logo=torproject&style=flat&logoColor=5d2f68 -[badge-platform-android]: http://img.shields.io/badge/-android-6EDB8D.svg?style=flat -[badge-platform-jvm]: http://img.shields.io/badge/-jvm-DB413D.svg?style=flat -[badge-platform-js]: http://img.shields.io/badge/-js-F8DB5D.svg?style=flat +[badge-platform-android]: https://img.shields.io/badge/-android-6EDB8D.svg?style=flat +[badge-platform-jvm]: https://img.shields.io/badge/-jvm-DB413D.svg?style=flat +[badge-platform-js]: https://img.shields.io/badge/-js-F8DB5D.svg?style=flat [badge-platform-js-node]: https://img.shields.io/badge/-nodejs-68a063.svg?style=flat -[badge-platform-linux]: http://img.shields.io/badge/-linux-2D3F6C.svg?style=flat -[badge-platform-macos]: http://img.shields.io/badge/-macos-111111.svg?style=flat -[badge-platform-ios]: http://img.shields.io/badge/-ios-CDCDCD.svg?style=flat -[badge-platform-tvos]: http://img.shields.io/badge/-tvos-808080.svg?style=flat -[badge-platform-watchos]: http://img.shields.io/badge/-watchos-C0C0C0.svg?style=flat +[badge-platform-linux]: https://img.shields.io/badge/-linux-2D3F6C.svg?style=flat +[badge-platform-macos]: https://img.shields.io/badge/-macos-111111.svg?style=flat +[badge-platform-ios]: https://img.shields.io/badge/-ios-CDCDCD.svg?style=flat +[badge-platform-tvos]: https://img.shields.io/badge/-tvos-808080.svg?style=flat +[badge-platform-watchos]: https://img.shields.io/badge/-watchos-C0C0C0.svg?style=flat [badge-platform-wasm]: https://img.shields.io/badge/-wasm-624FE8.svg?style=flat -[badge-platform-windows]: http://img.shields.io/badge/-windows-4D76CD.svg?style=flat -[badge-support-android-native]: http://img.shields.io/badge/support-[AndroidNative]-6EDB8D.svg?style=flat -[badge-support-apple-silicon]: http://img.shields.io/badge/support-[AppleSilicon]-43BBFF.svg?style=flat +[badge-platform-windows]: https://img.shields.io/badge/-windows-4D76CD.svg?style=flat +[badge-support-android-native]: https://img.shields.io/badge/support-[AndroidNative]-6EDB8D.svg?style=flat +[badge-support-apple-silicon]: https://img.shields.io/badge/support-[AppleSilicon]-43BBFF.svg?style=flat [badge-support-js-ir]: https://img.shields.io/badge/support-[js--IR]-AAC4E0.svg?style=flat [url-latest-release]: https://github.com/05nelsonm/kmp-tor/releases/latest @@ -253,16 +252,16 @@ public class Example2 { [url-kotlin]: https://kotlinlang.org [url-atomicfu]: https://github.com/Kotlin/kotlinx.atomicfu [url-coroutines]: https://github.com/Kotlin/kotlinx.coroutines -[url-encoding]: https://github.com/05nelsonm/component-encoding +[url-encoding]: https://github.com/05nelsonm/encoding [url-parcelize]: https://github.com/05nelsonm/component-parcelize [url-kmp-tor-binary]: https://github.com/05nelsonm/kmp-tor-binary -[url-android-kotlin-app]: https://github.com/05nelsonm/kmp-tor/tree/master/samples/kotlin/android/src/main/java/io/matthewnelson/kmp/tor/sample/kotlin/android -[url-android-kotlin-attrs]: https://github.com/05nelsonm/kmp-tor/blob/master/samples/kotlin/android/src/main/res/values/attrs.xml -[url-android-kotlin-manifest]: https://github.com/05nelsonm/kmp-tor/blob/master/samples/kotlin/android/src/main/AndroidManifest.xml -[url-android-java-app]: https://github.com/05nelsonm/kmp-tor/blob/master/samples/java/android/src/main/java/io/matthewnelson/kmp/tor/sample/java/android/App.java -[url-android-java-gradle]: https://github.com/05nelsonm/kmp-tor/blob/master/samples/java/android/build.gradle.kts -[url-javafx-kotlin-app]: https://github.com/05nelsonm/kmp-tor/blob/master/samples/kotlin/javafx/src/jvmMain/kotlin/io/matthewnelson/kmp/tor/sample/kotlin/javafx/SampleApp.kt -[url-javafx-kotlin-gradle]: https://github.com/05nelsonm/kmp-tor/blob/master/samples/kotlin/javafx/build.gradle.kts -[url-javafx-java-app]: https://github.com/05nelsonm/kmp-tor/blob/master/samples/java/javafx/src/main/java/io/matthewnelson/kmp/tor/sample/java/javafx/App.java -[url-javafx-java-gradle]: https://github.com/05nelsonm/kmp-tor/blob/master/samples/java/javafx/build.gradle.kts +[url-android-kotlin-app]: https://github.com/05nelsonm/kmp-tor/tree/1.x.x/samples/kotlin/android/src/main/java/io/matthewnelson/kmp/tor/sample/kotlin/android +[url-android-kotlin-attrs]: https://github.com/05nelsonm/kmp-tor/blob/1.x.x/samples/kotlin/android/src/main/res/values/attrs.xml +[url-android-kotlin-manifest]: https://github.com/05nelsonm/kmp-tor/blob/1.x.x/samples/kotlin/android/src/main/AndroidManifest.xml +[url-android-java-app]: https://github.com/05nelsonm/kmp-tor/blob/1.x.x/samples/java/android/src/main/java/io/matthewnelson/kmp/tor/sample/java/android/App.java +[url-android-java-gradle]: https://github.com/05nelsonm/kmp-tor/blob/1.x.x/samples/java/android/build.gradle.kts +[url-javafx-kotlin-app]: https://github.com/05nelsonm/kmp-tor/blob/1.x.x/samples/kotlin/javafx/src/jvmMain/kotlin/io/matthewnelson/kmp/tor/sample/kotlin/javafx/SampleApp.kt +[url-javafx-kotlin-gradle]: https://github.com/05nelsonm/kmp-tor/blob/1.x.x/samples/kotlin/javafx/build.gradle.kts +[url-javafx-java-app]: https://github.com/05nelsonm/kmp-tor/blob/1.x.x/samples/java/javafx/src/main/java/io/matthewnelson/kmp/tor/sample/java/javafx/App.java +[url-javafx-java-gradle]: https://github.com/05nelsonm/kmp-tor/blob/1.x.x/samples/java/javafx/build.gradle.kts [url-kmp-tor-master]: https://github.com/05nelsonm/kmp-tor/tree/master diff --git a/build-environment/src/main/kotlin/kmp/tor/env.kt b/build-environment/src/main/kotlin/kmp/tor/env.kt index d9a95cdad..6ff3182cc 100644 --- a/build-environment/src/main/kotlin/kmp/tor/env.kt +++ b/build-environment/src/main/kotlin/kmp/tor/env.kt @@ -18,7 +18,7 @@ package kmp.tor @Suppress("ClassName") object env { // Must be either "-SNAPSHOT" || "" - private const val SNAPSHOT = "-SNAPSHOT" + private const val SNAPSHOT = "" private const val MANAGER_VERSION_NAME = "1.4.5" // 1.0.0-alpha1 == 01_00_00_11 diff --git a/build-logic/src/main/kotlin/-KmpConfigurationExtension.kt b/build-logic/src/main/kotlin/-KmpConfigurationExtension.kt index 7aed199bd..60a3f700b 100644 --- a/build-logic/src/main/kotlin/-KmpConfigurationExtension.kt +++ b/build-logic/src/main/kotlin/-KmpConfigurationExtension.kt @@ -58,36 +58,36 @@ fun KmpConfigurationExtension.configureShared( } if (isCommonModule) { - js { - target { - nodejs { - testTask { - useMocha { timeout = "30s" } - } - } - } - } - - linuxX64() - mingwX64() - - iosArm32() - iosArm64() - iosX64() - iosSimulatorArm64() - - macosArm64() - macosX64() - - tvosArm64() - tvosX64() - tvosSimulatorArm64() - - watchosArm32() - watchosArm64() - watchosX64() - watchosX86() - watchosSimulatorArm64() +// js { +// target { +// nodejs { +// testTask { +// useMocha { timeout = "30s" } +// } +// } +// } +// } +// +// linuxX64() +// mingwX64() +// +// iosArm32() +// iosArm64() +// iosX64() +// iosSimulatorArm64() +// +// macosArm64() +// macosX64() +// +// tvosArm64() +// tvosX64() +// tvosSimulatorArm64() +// +// watchosArm32() +// watchosArm64() +// watchosX64() +// watchosX86() +// watchosSimulatorArm64() } common { diff --git a/library/manager/kmp-tor-manager/src/androidMain/kotlin/io/matthewnelson/kmp/tor/manager/TorManager.kt b/library/manager/kmp-tor-manager/src/androidMain/kotlin/io/matthewnelson/kmp/tor/manager/TorManager.kt index 04c216309..2137f5f47 100644 --- a/library/manager/kmp-tor-manager/src/androidMain/kotlin/io/matthewnelson/kmp/tor/manager/TorManager.kt +++ b/library/manager/kmp-tor-manager/src/androidMain/kotlin/io/matthewnelson/kmp/tor/manager/TorManager.kt @@ -25,6 +25,7 @@ import io.matthewnelson.kmp.tor.manager.common.TorOperationManager import io.matthewnelson.kmp.tor.manager.common.event.TorManagerEvent import io.matthewnelson.kmp.tor.manager.common.state.TorStateManager import io.matthewnelson.kmp.tor.manager.internal.* +import io.matthewnelson.kmp.tor.manager.internal.DEPRECATION_NOTICE import io.matthewnelson.kmp.tor.manager.internal.RealTorManagerAndroid import io.matthewnelson.kmp.tor.manager.internal.TorService @@ -58,6 +59,7 @@ import io.matthewnelson.kmp.tor.manager.internal.TorService * @see [TorStateManager] * @see [TorEventProcessor] * */ +@Deprecated(message = DEPRECATION_NOTICE) actual interface TorManager: Destroyable, TorControlManager, diff --git a/library/manager/kmp-tor-manager/src/commonMain/kotlin/io/matthewnelson/kmp/tor/manager/TorManager.kt b/library/manager/kmp-tor-manager/src/commonMain/kotlin/io/matthewnelson/kmp/tor/manager/TorManager.kt index c861c86cc..c9c69d54b 100644 --- a/library/manager/kmp-tor-manager/src/commonMain/kotlin/io/matthewnelson/kmp/tor/manager/TorManager.kt +++ b/library/manager/kmp-tor-manager/src/commonMain/kotlin/io/matthewnelson/kmp/tor/manager/TorManager.kt @@ -24,6 +24,7 @@ import io.matthewnelson.kmp.tor.manager.common.TorControlManager import io.matthewnelson.kmp.tor.manager.common.TorOperationManager import io.matthewnelson.kmp.tor.manager.common.event.TorManagerEvent import io.matthewnelson.kmp.tor.manager.common.state.TorStateManager +import io.matthewnelson.kmp.tor.manager.internal.DEPRECATION_NOTICE import io.matthewnelson.kmp.tor.manager.internal.RealTorManager /** @@ -55,6 +56,7 @@ import io.matthewnelson.kmp.tor.manager.internal.RealTorManager * @see [TorStateManager] * @see [TorEventProcessor] * */ +@Deprecated(message = DEPRECATION_NOTICE) expect interface TorManager: Destroyable, TorControlManager, diff --git a/library/manager/kmp-tor-manager/src/commonMain/kotlin/io/matthewnelson/kmp/tor/manager/internal/-CommonPlatform.kt b/library/manager/kmp-tor-manager/src/commonMain/kotlin/io/matthewnelson/kmp/tor/manager/internal/-CommonPlatform.kt index c6be0e32d..4db5c0154 100644 --- a/library/manager/kmp-tor-manager/src/commonMain/kotlin/io/matthewnelson/kmp/tor/manager/internal/-CommonPlatform.kt +++ b/library/manager/kmp-tor-manager/src/commonMain/kotlin/io/matthewnelson/kmp/tor/manager/internal/-CommonPlatform.kt @@ -15,4 +15,6 @@ **/ package io.matthewnelson.kmp.tor.manager.internal +internal const val DEPRECATION_NOTICE: String = "kmp-tor 1.x.x is deprecated. See: https://github.com/05nelsonm/kmp-tor/blob/master/MIGRATION.md" + internal expect fun realTorManagerInstanceDestroyed(instanceId: String) diff --git a/library/manager/kmp-tor-manager/src/jvmJsMain/kotlin/io/matthewnelson/kmp/tor/manager/TorManager.kt b/library/manager/kmp-tor-manager/src/jvmJsMain/kotlin/io/matthewnelson/kmp/tor/manager/TorManager.kt index d9906c6cd..999df75a4 100644 --- a/library/manager/kmp-tor-manager/src/jvmJsMain/kotlin/io/matthewnelson/kmp/tor/manager/TorManager.kt +++ b/library/manager/kmp-tor-manager/src/jvmJsMain/kotlin/io/matthewnelson/kmp/tor/manager/TorManager.kt @@ -22,6 +22,7 @@ import io.matthewnelson.kmp.tor.manager.common.TorControlManager import io.matthewnelson.kmp.tor.manager.common.TorOperationManager import io.matthewnelson.kmp.tor.manager.common.event.TorManagerEvent import io.matthewnelson.kmp.tor.manager.common.state.TorStateManager +import io.matthewnelson.kmp.tor.manager.internal.DEPRECATION_NOTICE import io.matthewnelson.kmp.tor.manager.internal.RealTorManager import io.matthewnelson.kmp.tor.manager.instance.InstanceId import io.matthewnelson.kmp.tor.manager.instance.TorMultiInstanceManager @@ -57,6 +58,7 @@ import kotlin.jvm.JvmStatic * @see [TorStateManager] * @see [TorEventProcessor] * */ +@Deprecated(message = DEPRECATION_NOTICE) actual interface TorManager: Destroyable, TorControlManager,