Prepare for release 0.15.0.

slackhq · Sep 20, 2023 · 0105eda · 0105eda
1 parent 44f06f9
commit 0105eda
Show file tree

Hide file tree

Showing 4 changed files with 664 additions and 467 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,38 @@
 Changelog
 =========
 
+0.15.0
+------
+
+_2023-09-20_
+
+## **New**: Allow retained state to be retained whilst UIs and Presenters are on the back stack.
+
+Originally, `circuit-retained` was implemented as a solution for preserving arbitrary data across configuration changes on Android. With this change it now also acts as a solution for retaining state _across the back stack_, meaning that traversing the backstack no longer causes restored contents to re-run through their empty states anymore.
+
+To support this, each back stack entry now has its own `RetainedStateRegistry` instance.
+
+Note that `circuit-retained` is still optional for now, but we are considering making it part of `CircuitCompositionLocals` in the future. Please let us know your thoughts in this issue: https://github.com/slackhq/circuit/issues/891.
+
+Full details + demos can be found in https://github.com/slackhq/circuit/pull/888. Big thank you to [@chrisbanes](https://github.com/chrisbanes) for the implementation!
+
+## Other changes
+
+- **New**: Add `collectAsRetainedState` utility function, analogous to `collectAsState` but will retain the previous value across configuration changes and back stack entries.
+- **Enhancement**: Optimize `rememberRetained` with a port of the analogous optimization in `rememberSaveable`. See [#850](https://github.com/slackhq/circuit/pull/850).
+- **Enhancement**: `Presenter` and `Ui` interfaces are now annotated as `@Stable`.
+- **Fix**: Fix `GestureNavigationDecoration` function parameter order.
+- **Fix**: `BackHandler` on iOS now has the proper file name.
+- **Fix**: Key the `presenter.present()` in `CircuitContent` on the `Screen` rather than the `presenter` itself, which fixes a severe issue that prevented `currentCompositeKeyHash` from working correctly on `rememberRetained` and `rememberSaveable` uses.
+- Update CM compiler to `1.5.2`.
+- Update CM to `1.5.1`.
+- Update `androidx.compose.animation` to `1.5.1`.
+- Update `androidx.compose.foundation` to `1.5.1`.
+- Update `androidx.compose.runtime` to `1.5.1`.
+- Update `androidx.compose.material` to `1.5.1`.
+- Update `androidx.lifecycle` to `2.6.2`.
+- Update `androidx.annotation` to `1.7.0`.
+
 0.14.1
 ------
 

diff --git a/circuit-foundation/src/androidMain/generated/baselineProfiles/baseline-prof.txt b/circuit-foundation/src/androidMain/generated/baselineProfiles/baseline-prof.txt
diff --git a/gradle.properties b/gradle.properties
@@ -66,7 +66,7 @@ POM_DEVELOPER_ID=slackhq
 POM_DEVELOPER_NAME=Slack Technologies, Inc.
 POM_DEVELOPER_URL=https://github.com/slackhq
 POM_INCEPTION_YEAR=2022
-VERSION_NAME=0.15.0-SNAPSHOT
+VERSION_NAME=0.15.0
 
 circuit.mavenUrls.snapshots.sonatype=https://oss.sonatype.org/content/repositories/snapshots
 circuit.mavenUrls.snapshots.sonatypes01=https://s01.oss.sonatype.org/content/repositories/snapshots