on master help sign in
Merge pull request #661 from obsidiansystems/add-missing-release-note-in-routes-for-0-3

Add missing changelog entry for obelisk 0.3 routes change

commit0133449c597afdb3d4aaeb7a6475610b7bca6c99 authorElliot Cameron <3noch@users.noreply.github.com> dateThu 20 Feb 2020, 13:30 (7 years ago) parentfc876df86a8d6e
1 file changed+14
ChangeLog.md+14
ChangeLog.md+14
@@ -36,6 +36,20 @@ This project's release branch is `master`. This log is written from the perspect
3636
3737## v0.3.0.0 - 2019-12-20
3838
39+* Change the structure of Obelisk routes to use a designated
40+ `FullRoute` type. This combines frontend and backend routes into one
41+ structure. This is a **breaking** change which requires Obelisk apps
42+ to take specific migrations. They are:
43+ * Rewrite the implementation of `_backend_routeEncoder` in
44+ `Backend` to use `mkFullRouteEncoder` instead of
45+ `handleEncoder`. Specifically, the backend and frontend cases of
46+ the top-level `pathComponentEncoder` become the second and third
47+ arguments of `mkFullRouteEncoder` respectively, while the
48+ missing route becomes the first argument. An example of how to
49+ do this is available in [a reflex-examples
50+ commit](https://github.com/reflex-frp/reflex-examples/commits/28f566c3e7dc615578dc74297b7c620c1f13683e).
51+ * Replace type constructions of `InL` with `FullRoute_Backend` and
52+ `InR` with `FullRoute_Frontend`.
3953* Generalised `pathSegmentEncoder`, added `pathFieldEncoder`.
4054* Added some `Prism`s to the encoder library for manipulating `DSum`s.
4155* Add `ob doc` command, which lists paths to haddock documentation for specified packages.