From 9f9d36501c3e192b9a64ea4d03eb14ca326c70b0 Mon Sep 17 00:00:00 2001 From: Jake Wharton Date: Wed, 21 Jun 2023 00:16:49 -0400 Subject: [PATCH] Prepare version 1.0.0 --- .github/workflows/release.yaml | 2 +- CHANGELOG.md | 13 ++++++++++++- README.md | 10 ++++++++-- gradle.properties | 2 +- 4 files changed, 22 insertions(+), 5 deletions(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index c4404932..ef2d4c92 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -42,5 +42,5 @@ jobs: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} BRANCH: site FOLDER: build/dokka/html - TARGET_FOLDER: docs/0.x/ + TARGET_FOLDER: docs/1.x/ CLEAN: true diff --git a/CHANGELOG.md b/CHANGELOG.md index eda216ff..f051a6b8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,15 @@ ## [Unreleased] +## [1.0.0] - 2023-05-21 +### Added +- Add `turbineScope` DSL function which is now required for using `testIn`. This ensures that exceptions which occur within the test are no longer potentially lost. + +### Changed +- Failed `Turbine`s which occur while testing a `Flow` (using `test { }`) will now have their failures eagerly reported. +- Build with Kotlin 1.8.22 and kotlinx.coroutines 1.7.1. Note: Future releases will not highlight the Kotlin or coroutines version unless important for some other reason. + + ## [0.13.0] - 2023-05-11 ### Added - New Kotlin/Native targets: @@ -152,7 +161,9 @@ Note: This version has a transitive dependency on kotlinx.coroutines 1.7.0. If y Initial release -[Unreleased]: https://github.com/cashapp/turbine/compare/0.12.3...HEAD +[Unreleased]: https://github.com/cashapp/turbine/compare/1.0.0...HEAD +[1.0.0]: https://github.com/cashapp/turbine/releases/tag/1.0.0 +[0.13.0]: https://github.com/cashapp/turbine/releases/tag/0.13.0 [0.12.3]: https://github.com/cashapp/turbine/releases/tag/0.12.3 [0.12.2]: https://github.com/cashapp/turbine/releases/tag/0.12.2 [0.12.1]: https://github.com/cashapp/turbine/releases/tag/0.12.1 diff --git a/README.md b/README.md index 7673e543..4ec4291c 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ repositories { mavenCentral() } dependencies { - testImplementation 'app.cash.turbine:turbine:0.13.0' + testImplementation 'app.cash.turbine:turbine:1.0.0' } ``` @@ -37,13 +37,19 @@ repositories { } } dependencies { - testImplementation 'app.cash.turbine:turbine:0.14.0-SNAPSHOT' + testImplementation 'app.cash.turbine:turbine:1.1.0-SNAPSHOT' } ```

+While Turbine's own API is stable, we are currently forced to depend on an unstable API from +kotlinx.coroutines test artifact: `UnconfinedTestDispatcher`. Without this usage of Turbine with +`runTest` would break. It's possible for future coroutine library updates to alter the behavior of +this library as a result. We will make every effort to ensure behavioral stability as well until this +API dependency is stabilized (tracking [issue #132](https://github.com/cashapp/turbine/issues/132)). + ## Usage A `Turbine` is a thin wrapper over a `Channel` with an API designed for testing. diff --git a/gradle.properties b/gradle.properties index 7f6bc189..49e9140d 100644 --- a/gradle.properties +++ b/gradle.properties @@ -2,7 +2,7 @@ GROUP=app.cash.turbine POM_ARTIFACT_ID=turbine # HEY! If you change the major version here be sure to update release.yaml doc target folder! -VERSION_NAME=0.14.0-SNAPSHOT +VERSION_NAME=1.0.0 SONATYPE_AUTOMATIC_RELEASE=true SONATYPE_HOST=DEFAULT