Update version and changelog for release

Cleanup buildsrc and update version/changelog for realease of v2.0.1
pablobaxter · Oct 8, 2024 · e3d04e4 · e3d04e4
1 parent 5d49b68
commit e3d04e4
Show file tree

Hide file tree

Showing 9 changed files with 22 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Change Log
 
+### Version 2.0.1 / 2024-10-07
+* Add license to PreferenceUtil.kt
+* Fix crash "IllegalStateException: Recursive update" on Coroutines library (#23)
+* Deprecates getObjectNonNull() function (#24)
+* Correct the exception message when incorrect sharedprefereces is listened to (#26)
+* Add in docs and website for Rx-Preferences (#25)
+* Deprecates `RxSharedPreferences.getObjectNonNull()` in favor of `RxSharedPreferences.getObject()`
+
 ### Version 2.0.0 / 2024-09-30
 * **Breaking Change release**
 * Use extension functions for Rx libraries

diff --git a/README.md b/README.md
@@ -14,34 +14,34 @@ In order to handle the varying number of reactive frameworks available, there ar
 
 [Core][3]
 ```groovy
-implementation 'com.frybits.rx.preferences:core:2.0.0'
+implementation 'com.frybits.rx.preferences:core:2.0.1'
 ```
 
 [Coroutine/Flow][4]
 ```groovy
-implementation 'com.frybits.rx.preferences:coroutine:2.0.0'
+implementation 'com.frybits.rx.preferences:coroutine:2.0.1'
 ```
 
 [LiveData][5]
 ```groovy
-implementation 'com.frybits.rx.preferences:livedata:2.0.0'
+implementation 'com.frybits.rx.preferences:livedata:2.0.1'
 ```
 
 [Rx2][6]
 ```groovy
-implementation 'com.frybits.rx.preferences:rx2:2.0.0'
+implementation 'com.frybits.rx.preferences:rx2:2.0.1'
 ```
 
 [Rx3][7]
 ```groovy
-implementation 'com.frybits.rx.preferences:rx3:2.0.0'
+implementation 'com.frybits.rx.preferences:rx3:2.0.1'
 ```
 
 For ease of ensuring all libraries are compatible, as they may have varying release cadences, a BOM is also provided:
 
 ```groovy
 // Import BOM
-implementation platform('com.frybits.rx.preferences:bom:2.0.0')
+implementation platform('com.frybits.rx.preferences:bom:2.0.1')
 implementation 'com.frybits.rx.preferences:core'
 implementation 'com.frybits.rx.preferences:livedata'
 implementation 'com.frybits.rx.preferences:rx2'
@@ -80,5 +80,5 @@ License
 [11]:./LICENSE
 
 [12]:https://img.shields.io/maven-central/v/com.frybits.rx.preferences/bom?label=bom
-[13]:https://central.sonatype.com/artifact/com.frybits.rx.preferences/bom/2.0.0
+[13]:https://central.sonatype.com/artifact/com.frybits.rx.preferences/bom/2.0.1
 [14]:https://rx-preferences.frybits.com
diff --git a/buildSrc/src/main/kotlin/com/frybits/gradle/FrybitsLibraryPlugin.kt b/buildSrc/src/main/kotlin/com/frybits/gradle/FrybitsLibraryPlugin.kt
@@ -5,12 +5,8 @@ import com.android.build.gradle.LibraryPlugin
 import com.vanniktech.maven.publish.MavenPublishPlugin
 import org.gradle.api.Plugin
 import org.gradle.api.Project
-import org.gradle.api.artifacts.VersionCatalog
-import org.gradle.api.artifacts.VersionCatalogsExtension
 import org.gradle.kotlin.dsl.apply
 import org.gradle.kotlin.dsl.configure
-import org.gradle.kotlin.dsl.getByName
-import org.gradle.kotlin.dsl.the
 import org.gradle.kotlin.dsl.withType
 import org.jetbrains.dokka.gradle.DokkaMultiModuleTask
 import org.jetbrains.dokka.gradle.DokkaPlugin
@@ -73,6 +69,7 @@ private fun Project.configureDokka() {
     apply<DokkaPlugin>()
     val mmTask = tasks.findByName("dokkaHtmlMultiModule") as? DokkaMultiModuleTask
     if (mmTask != null) {
+        // Disabling for library modules, so the app submodule doesn't publish docs
         mmTask.enabled = false
     }
     tasks.withType<DokkaTaskPartial> {

diff --git a/docs/core.md b/docs/core.md
@@ -4,7 +4,7 @@ The core library provides the `RxSharedPreferences` class that contains APIs to
 
 ## Getting the dependency
 ```groovy
-implementation "com.frybits.rx.preferences:core:2.0.0"
+implementation "com.frybits.rx.preferences:core:2.0.1"
 ```
 
 ## Usage

diff --git a/docs/coroutines.md b/docs/coroutines.md
@@ -6,7 +6,7 @@ The coroutines library adds extension functions to convert the `Prefrence` into
 
 ## Getting the dependency
 ```groovy
-implementation "com.frybits.rx.preferences:coroutines:2.0.0"
+implementation "com.frybits.rx.preferences:coroutines:2.0.1"
 ```
 
 ## Usage

diff --git a/docs/livedata.md b/docs/livedata.md
@@ -4,7 +4,7 @@ The livedata library adds extension functions to convert the `Prefrence` into `L
 
 ## Getting the Dependency
 ```groovy
-implementation "com.frybits.rx.preferences:livedata:2.0.0"
+implementation "com.frybits.rx.preferences:livedata:2.0.1"
 ```
 
 ## Usage

diff --git a/docs/rx2.md b/docs/rx2.md
@@ -4,7 +4,7 @@ The livedata library adds extension functions to convert the `Prefrence` into `O
 
 ## Getting the Dependency
 ```groovy
-implementation "com.frybits.rx.preferences:rx2:2.0.0"
+implementation "com.frybits.rx.preferences:rx2:2.0.1"
 ```
 
 ## Usage

diff --git a/docs/rx3.md b/docs/rx3.md
@@ -4,7 +4,7 @@ The livedata library adds extension functions to convert the `Prefrence` into `O
 
 ## Getting the Dependency
 ```groovy
-implementation "com.frybits.rx.preferences:rx3:2.0.0"
+implementation "com.frybits.rx.preferences:rx3:2.0.1"
 ```
 
 ## Usage

diff --git a/gradle.properties b/gradle.properties
@@ -26,7 +26,7 @@ org.gradle.caching=true
 # Disabled until dokka task is fixed
 org.gradle.configuration-cache=false
 
-VERSION_NAME=2.0.0
+VERSION_NAME=2.0.1
 
 POM_URL=https://github.com/pablobaxter/rx-preferences
 POM_SCM_URL=https://github.com/pablobaxter/rx-preferences