From 2cc56e42f7fc3b23c3c1046272dcb464587174b5 Mon Sep 17 00:00:00 2001 From: Patrick Jackson Date: Sun, 16 Aug 2020 22:06:06 -0400 Subject: [PATCH 1/2] update docs for 0.5.5 --- CHANGELOG.md | 6 +++ README.md | 4 +- gradle/publish.gradle | 50 ++++++++++----------- website/docs/introduction/GettingStarted.md | 6 +-- website/docs/introduction/Threading.md | 2 +- 5 files changed, 37 insertions(+), 31 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0722f6a..1e99aa8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ ## Unreleased +## [0.5.5] - 2020-08-16 + - update to Kotlin 1.4.0 + - added platforms (androidNativeArm32, androidNativeArm64, iosArm32, linuxArm64, linuxX64, + mingwX86, tvosArm64, tvosX64, watchosArm32, watchosArm64, watchosX86) + - remove spek & atrium deps and use plain kotlin tests & assertions. Tests run for all platforms now. + ## [0.5.2] - 2020-07-03 - publish all available platforms to maven - add CI/CD through github actions diff --git a/README.md b/README.md index 3cb5738..4540614 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ kotlin { sourceSets { commonMain { // <--- name may vary on your project dependencies { - implementation "org.reduxkotlin:redux-kotlin-threadsafe:0.5.2" + implementation "org.reduxkotlin:redux-kotlin-threadsafe:0.5.5" } } } @@ -54,7 +54,7 @@ kotlin { For JVM only: ``` - implementation "org.reduxkotlin:redux-kotlin-threadsafe-jvm:0.5.2" + implementation "org.reduxkotlin:redux-kotlin-threadsafe-jvm:0.5.5" ``` *Non threadsafe store is available. Typical usage will be with the threadsafe store. [More info read here](https://www.reduxkotlin.org/introduction/getting-started) diff --git a/gradle/publish.gradle b/gradle/publish.gradle index eca7733..c047f4d 100644 --- a/gradle/publish.gradle +++ b/gradle/publish.gradle @@ -20,27 +20,27 @@ dokka { path = kotlin.sourceSets.commonMain.kotlin.srcDirs[0] platforms = ["Common"] } - if (kotlin.sourceSets.getNames().contains("jvmMain")) { - sourceRoot { - // assuming there is only a single source dir... - path = kotlin.sourceSets.jvmMain.kotlin.srcDirs[0] - platforms = ["JVM"] - } - } - if (kotlin.sourceSets.getNames().contains("jsMain")) { - sourceRoot { - // assuming there is only a single source dir... - path = kotlin.sourceSets.jsMain.kotlin.srcDirs[0] - platforms = ["js"] - } - } - if (kotlin.sourceSets.getNames().contains("nativeMain")) { - sourceRoot { - // assuming there is only a single source dir... - path = kotlin.sourceSets.nativeMain.kotlin.srcDirs[0] - platforms = ["native"] - } - } +// if (kotlin.sourceSets.getNames().contains("jvmMain")) { +// sourceRoot { +// // assuming there is only a single source dir... +// path = kotlin.sourceSets.jvmMain.kotlin.srcDirs[0] +// platforms = ["JVM"] +// } +// } +// if (kotlin.sourceSets.getNames().contains("jsMain")) { +// sourceRoot { +// // assuming there is only a single source dir... +// path = kotlin.sourceSets.jsMain.kotlin.srcDirs[0] +// platforms = ["js"] +// } +// } +// if (kotlin.sourceSets.getNames().contains("nativeMain")) { +// sourceRoot { +// // assuming there is only a single source dir... +// path = kotlin.sourceSets.nativeMain.kotlin.srcDirs[0] +// platforms = ["native"] +// } +// } } def isReleaseBuild() { @@ -76,10 +76,10 @@ task javadocsJar(type: Jar, dependsOn: dokka) { signing { required { isReleaseBuild() /*&& gradle.taskGraph.hasTask("uploadArchives") */ } - def signingKey = findProperty("GPG_SECRET") ?: System.getenv('GPG_SECRET') ?: "" - def signingPassword = findProperty("GPG_SIGNING_PASSWORD") ?: System.getenv('GPG_SIGNING_PASSWORD') ?: "" - useInMemoryPgpKeys(signingKey, signingPassword) - sign(publishing.publications) +// def signingKey = findProperty("GPG_SECRET") ?: System.getenv('GPG_SECRET') ?: "" +// def signingPassword = findProperty("GPG_SIGNING_PASSWORD") ?: System.getenv('GPG_SIGNING_PASSWORD') ?: "" +// useInMemoryPgpKeys(signingKey, signingPassword) +// sign(publishing.publications) } publishing { diff --git a/website/docs/introduction/GettingStarted.md b/website/docs/introduction/GettingStarted.md index 6be5e15..da6f1a0 100644 --- a/website/docs/introduction/GettingStarted.md +++ b/website/docs/introduction/GettingStarted.md @@ -33,7 +33,7 @@ kotlin { sourceSets { commonMain { dependencies { - implementation "org.reduxkotlin:redux-kotlin-threadsafe:0.5.2" + implementation "org.reduxkotlin:redux-kotlin-threadsafe:0.5.5" } } } @@ -47,11 +47,11 @@ __For single platform project (i.e. just Android):__ ```groovy dependencies { - implementation "org.reduxkotlin:redux-kotlin-threadsafe-jvm:0.5.2" + implementation "org.reduxkotlin:redux-kotlin-threadsafe-jvm:0.5.5" } ``` -NOTE: If threadsafety is not a concern (i.e. a JS only project) "org.reduxkotlin:redux-kotlin:0.5.2" may be used. +NOTE: If threadsafety is not a concern (i.e. a JS only project) "org.reduxkotlin:redux-kotlin:0.5.5" may be used. [**More info on threading available here.**](/introduction/threading) ## Basic Example diff --git a/website/docs/introduction/Threading.md b/website/docs/introduction/Threading.md index f2db0f6..c3826c0 100644 --- a/website/docs/introduction/Threading.md +++ b/website/docs/introduction/Threading.md @@ -74,7 +74,7 @@ kotlin { sourceSets { commonMain { dependencies { - implementation "org.reduxkotlin:redux-kotlin:0.5.2" + implementation "org.reduxkotlin:redux-kotlin:0.5.5" } } } From a42ca29f46f57e181c4b3e6107293a9e390e5fb3 Mon Sep 17 00:00:00 2001 From: Patrick Jackson Date: Mon, 17 Aug 2020 06:42:46 -0400 Subject: [PATCH 2/2] fix typo --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4540614..d4d0185 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ ![CI](https://github.com/reduxkotlin/redux-kotlin/workflows/CI/badge.svg) ![badge][badge-android] +![badge][badge-ios] ![badge][badge-native] ![badge][badge-js] ![badge][badge-jvm] @@ -27,7 +28,7 @@ Provide a standard redux implementation for Kotlin. In doing so will foster a e Redux in Kotlin, and in mobile in particular, may differ a bit from javascript. Many have found the basic pattern useful on Android & iOS leading to tens of opensource redux libraries in Kotlin, Java, and Swift, yet an ecosystem has yet to emerge. A port of javascript redux is a good starting point for creating a standard and will aid in cross-pollination of middleware, store enhancers, & dev tools from the javascript world. -Redux has proven helpful for state managment in mobile. A multiplatform Kotlin implementation & ecosystem will increase developer productivity and code reuse across platforms. +Redux has proven helpful for state management in mobile. A multiplatform Kotlin implementation & ecosystem will increase developer productivity and code reuse across platforms. [Droidcon NYC Slides](https://www.slideshare.net/PatrickJackson14/reduxkotlinorg-droidcon-nyc-2019) Video TBA