Skip to content

Commit

Permalink
Prepare release 0.26
Browse files Browse the repository at this point in the history
- Bumped version
- Updated setup in README
  • Loading branch information
evant committed May 13, 2023
1 parent 967dba2 commit d79724c
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 10 deletions.
8 changes: 6 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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`
Expand Down
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion gradle/libs.versions.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[versions]
assertk = "0.26-SNAPSHOT"
assertk = "0.26"
kotlin = "1.8.10"
kotlinx-coroutines = "1.7.0"
[libraries]
Expand Down

0 comments on commit d79724c

Please sign in to comment.