From d79724cb3586d3fac909078cea9f9ebf8e6a5ca4 Mon Sep 17 00:00:00 2001 From: Evan Tatarka Date: Fri, 12 May 2023 16:55:12 -0700 Subject: [PATCH] Prepare release 0.26 - Bumped version - Updated setup in README --- CHANGELOG.md | 8 ++++++-- README.md | 25 ++++++++++++++++++------- gradle/libs.versions.toml | 2 +- 3 files changed, 25 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f2579e14..3145d1e1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,12 +9,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### Changed - Minimum supported kotlin version is 1.8.10 - Minimum supported coroutines version is 1.7.0 -- Lambda-accepting `assertThat { }` entrypoint is now deprecated. - Use `assertThat(T)` for normal values or `assertFailure { }` for exception-throwing code. - When asserting on a `Throwable` or failed `Result`, their exception is added as the cause to any `AssertionError`s which are thrown as the result of an assertion failure. - Removed second type parameter on `Any.isInstanceOf` extension. In practice this would generally widen to `Any` which is what it has been replaced with. + +### Breaking Changes - Previous deprecations are now errors ### Added @@ -28,6 +28,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. - Added sequence assertions to mirror iterable - Added array assertions for `UByteArray`, `UShortArray`, `UIntArray`, and `ULongArray`. +### Deprecated +- Lambda-accepting `assertThat { }` entrypoint is now deprecated. + Use `assertThat(T)` for normal values or `assertFailure { }` for exception-throwing code. + ### Fixed - Fixed iterable assertions that take a block that could have multiple assertions. Includes: `none`,`atLeast`,`atMost`,`exactly`, and `any` diff --git a/README.md b/README.md index 2e3c5abe..6d36232c 100644 --- a/README.md +++ b/README.md @@ -16,22 +16,33 @@ See [Custom Assertions](#custom-assertions) below to find out how to do this. ## Setup -### Gradle/JVM - -```groovy +```kotlin repositories { mavenCentral() } dependencies { - testImplementation 'com.willowtreeapps.assertk:assertk-jvm:0.25' + testImplementation("com.willowtreeapps.assertk:assertk:0.26") } ``` -### Javascript/Common +assertk has full multiplatform support and it can be used in jvm, js, or native projects. For example to set it up using +the multiplatform plugin: +```kotlin +plugins { + kotlin("multiplatform") +} -Replace dependency on `assertk-jvm` with `assertk-js` or `assertk` to use it in JavaScript and common projects, -respectively. +kotlin { + sourceSets { + val commonTest by getting { + dependencies { + implementation("com.willowtreeapps.assertk:assertk:0.26") + } + } + } +} +``` ## Usage diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 2a7a5222..eb8b6191 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -1,5 +1,5 @@ [versions] -assertk = "0.26-SNAPSHOT" +assertk = "0.26" kotlin = "1.8.10" kotlinx-coroutines = "1.7.0" [libraries]