2.2.1 (#289)

Author: mickael-menu

CHANGELOG.md

@@ -4,7 +4,9 @@ All notable changes to this project will be documented in this file. Take a look
 
 **Warning:** Features marked as *experimental* may change or be removed in a future release without notice. Use with caution.
 
-## [Unreleased]
+<!--## [Unreleased]-->
+
+## [2.2.1]
 
 ### Fixed
 
@@ -537,4 +539,5 @@ server.loadCustomResource(assets.open("scripts/highlight.js"), "highlight.js", I
 [2.1.0]: https://github.com/readium/kotlin-toolkit/compare/2.0.0...2.1.0
 [2.1.1]: https://github.com/readium/kotlin-toolkit/compare/2.1.0...2.1.1
 [2.2.0]: https://github.com/readium/kotlin-toolkit/compare/2.1.1...2.2.0
+[2.2.1]: https://github.com/readium/kotlin-toolkit/compare/2.2.0...2.2.1
 

README.md

@@ -24,7 +24,7 @@ Make sure that you have the `$readium_version` property set in your root `build.
 
 ```gradle
 buildscript {
-    ext.readium_version = '2.2.0'
+    ext.readium_version = '2.2.1'
 }
 
 allprojects {

docs/migration-guide.md

@@ -2,6 +2,23 @@
 
 All migration steps necessary in reading apps to upgrade to major versions of the Kotlin Readium toolkit will be documented in this file.
 
+## 2.2.1
+
+This hotfix release fixes an issue [pulling a third-party dependency (NanoHTTPD) from JitPack](https://github.com/readium/kotlin-toolkit/issues/286).
+
+After upgrading, make sure to remove the dependency to NanoHTTPD from your app's `build.gradle` file before building:
+
+```diff
+-implementation("com.github.edrlab.nanohttpd:nanohttpd:master-SNAPSHOT") {
+-    exclude(group = "org.parboiled")
+-}
+-implementation("com.github.edrlab.nanohttpd:nanohttpd-nanolets:master-SNAPSHOT") {
+-    exclude(group = "org.parboiled")
+-}
+```
+
+:point_up: If you are stuck with an older version of Readium, you can [use this workaround in your root `build.gradle`](https://github.com/readium/kotlin-toolkit/issues/286#issuecomment-1283408861), as an alternative.
+
 ## 2.1.0
 
 With this new release, we migrated all the [`r2-*-kotlin`](https://github.com/readium/?q=r2-kotlin) repositories to [a single `kotlin-toolkit` repository](https://github.com/readium/r2-testapp-kotlin/issues/461).

test-app/build.gradle.kts

@@ -20,7 +20,7 @@ android {
 
         applicationId = "org.readium.r2reader"
 
-        versionName = "2.2.0"
+        versionName = "2.2.1"
 
         testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
         ndk.abiFilters.add("armeabi-v7a")