Skip to content

Commit d79724c

Browse files
committed
Prepare release 0.26
- Bumped version - Updated setup in README
1 parent 967dba2 commit d79724c

3 files changed

Lines changed: 25 additions & 10 deletions

File tree

CHANGELOG.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
99
### Changed
1010
- Minimum supported kotlin version is 1.8.10
1111
- Minimum supported coroutines version is 1.7.0
12-
- Lambda-accepting `assertThat { }` entrypoint is now deprecated.
13-
Use `assertThat(T)` for normal values or `assertFailure { }` for exception-throwing code.
1412
- When asserting on a `Throwable` or failed `Result`, their exception is added as the cause to any
1513
`AssertionError`s which are thrown as the result of an assertion failure.
1614
- Removed second type parameter on `Any.isInstanceOf` extension. In practice this would generally widen
1715
to `Any` which is what it has been replaced with.
16+
17+
### Breaking Changes
1818
- Previous deprecations are now errors
1919

2020
### Added
@@ -28,6 +28,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
2828
- Added sequence assertions to mirror iterable
2929
- Added array assertions for `UByteArray`, `UShortArray`, `UIntArray`, and `ULongArray`.
3030

31+
### Deprecated
32+
- Lambda-accepting `assertThat { }` entrypoint is now deprecated.
33+
Use `assertThat(T)` for normal values or `assertFailure { }` for exception-throwing code.
34+
3135
### Fixed
3236
- Fixed iterable assertions that take a block that could have multiple assertions.
3337
Includes: `none`,`atLeast`,`atMost`,`exactly`, and `any`

README.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,33 @@ See [Custom Assertions](#custom-assertions) below to find out how to do this.
1616

1717
## Setup
1818

19-
### Gradle/JVM
20-
21-
```groovy
19+
```kotlin
2220
repositories {
2321
mavenCentral()
2422
}
2523

2624
dependencies {
27-
testImplementation 'com.willowtreeapps.assertk:assertk-jvm:0.25'
25+
testImplementation("com.willowtreeapps.assertk:assertk:0.26")
2826
}
2927
```
3028

31-
### Javascript/Common
29+
assertk has full multiplatform support and it can be used in jvm, js, or native projects. For example to set it up using
30+
the multiplatform plugin:
31+
```kotlin
32+
plugins {
33+
kotlin("multiplatform")
34+
}
3235

33-
Replace dependency on `assertk-jvm` with `assertk-js` or `assertk` to use it in JavaScript and common projects,
34-
respectively.
36+
kotlin {
37+
sourceSets {
38+
val commonTest by getting {
39+
dependencies {
40+
implementation("com.willowtreeapps.assertk:assertk:0.26")
41+
}
42+
}
43+
}
44+
}
45+
```
3546

3647
## Usage
3748

gradle/libs.versions.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[versions]
2-
assertk = "0.26-SNAPSHOT"
2+
assertk = "0.26"
33
kotlin = "1.8.10"
44
kotlinx-coroutines = "1.7.0"
55
[libraries]

0 commit comments

Comments
 (0)