From 1e46e85cdf04db878a3161fe19ff033fa25c224d Mon Sep 17 00:00:00 2001 From: Sridhar Ratnakumar Date: Wed, 8 Jun 2022 12:01:51 -0400 Subject: [PATCH] Expand changelog --- CHANGELOG.md | 17 +++++++++++++---- docs/guide/upgrade.md | 14 ++++++++++++-- 2 files changed, 25 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 45d5751..a3ba811 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,14 +1,23 @@ # Revision history for ema -## Unreleased +## 0.8.0.0 (Unreleased) + +This is a significant release. If you choose to upgrade your apps from 0.6, see https://ema.srid.ca/guide/upgrade - GHC 9.0 support - Better handling of URL anchors (#83; #87) - Multisite rewrite (Ema is rewritten) - - Add `IsRoute` class to define route encoders + - Add the notion of `RouteEncoder` (first-class values), along with a `IsRoute` class to define them. - Generic deriving of route encoders, so you do not have to hand-write them. - - Route encoding isomorphism checks - - Composable Ema apps (Extend another Ema to build new ones) + - Automatic isomorphism checks ensures that encoding and decoding are isomorphic. + - Composable Ema apps + - There are two ways of composing Ema apps. Using heterogenous lists (see `Ema.Multi`), or by defining a top-level route type (see `Ex04_Multi.hs`). + - Replace `LVar` with `Dynamic`. + - Ema still uses `LVar` internally (for live server updates), but on the user-side one only needs to provide a `Dynamic` which is a tuple of initial value and an updating function. The [unionmount](https://github.com/srid/unionmount/pull/1) library was changed to provide this tuple. + - Add `EmaSite` typeclass to "connect them all" + - `SiteArg`: Type of value to pass from the environment. + - `siteInput`: Define the `Dynamic` model for the site. + - `siteOutput`: Asset (eg: HTML) to produce for each route. ## 0.6.0.0 -- 2022-02-05 diff --git a/docs/guide/upgrade.md b/docs/guide/upgrade.md index d96787b..8323d65 100644 --- a/docs/guide/upgrade.md +++ b/docs/guide/upgrade.md @@ -1,12 +1,22 @@ # Upgrading to newer Ema +Until 1.0 is released, newer releases of Ema might seen breaking or significant changes. This page exists to help you with upgrading your apps to the latest version. + ## 0.6 -> 0.8 -`0.8` is a *substantial* change, with Ema almost rewritten entirely. See [PR #81](https://github.com/srid/ema/pull/81) called 'Multisite rewrite'. If you do not wish to upgrade, you should stay with version `0.6`. +`0.8` is a *substantial* change, with Ema almost rewritten entirely. See [PR #81](https://github.com/srid/ema/pull/81) called 'Multisite rewrite'. TODO: How to upgrade to 0.8? - `RouteEncoder` (first-class route encoders) - Pass it around, for use in `Ema.routeUrl`, etc. -- `EmaSite` defines both "input" (model dynamic) and "output" (html rendering) \ No newline at end of file +- `EmaSite` defines both "input" (model dynamic) and "output" (html rendering) + + +### Apps that already use Ema 0.8 + +You may want to read the source code of these apps to further understand how to upgrade. + +- https://github.com/srid/emanote +- https://github.com/srid/timedot-invoice \ No newline at end of file