git.iko.soy/obelisk
on master help sign in
Add missing changelog entry for obelisk 0.3 routes change

In b6da186353c525aaf674e16933b48311dca5a1d3, we added a new FullRoute structure that contains the frontend, backend, and missing routes. This included changes to the skeleton, but was missing a note in the changelog that previous apps based off of the skeleton (or really any obelisk apps) needed to be updated. This change adds the missing note to the changelog. Emphasis is made that this is a breaking change that requires some changes on the user’s part. Some idea of what the user needs to do is given as well. I have also included an example for what I had to do in reflex-examples to get it working with Obelisk routes.

commit550f9d3682d14ab99429b932a86a8f7c7ce6b205 authorMatthew Bauer <mjbauer95@gmail.com> dateWed 19 Feb 2020, 17:38 (7 years ago) parent57fd855
1 file changed+14
compare with master
unifiedsplit
ChangeLog.md+14
ChangeLog.md+14
@@ -24,6 +24,20 @@ This project's release branch is `master`. This log is written from the perspect
2424
2525## v0.3.0.0 - 2019-12-20
2626
27+* Change the structure of Obelisk routes to use a designated
28+ `FullRoute` type. This combines frontend and backend routes into one
29+ structure. This is a **breaking** change which requires Obelisk apps
30+ to take specific migrations. They are:
31+ * Rewrite the implementation of `_backend_routeEncoder` in
32+ `Backend` to use `mkFullRouteEncoder` instead of
33+ `handleEncoder`. Specifically, the backend and frontend cases of
34+ the top-level `pathComponentEncoder` become the second and third
35+ arguments of `mkFullRouteEncoder` respectively, while the
36+ missing route becomes the first argument. An example of how to
37+ do this is available in [a reflex-examples
38+ commit](https://github.com/reflex-frp/reflex-examples/commits/28f566c3e7dc615578dc74297b7c620c1f13683e).
39+ * Replace type constructions of `InL` with `FullRoute_Backend` and
40+ `InR` with `FullRoute_Frontend`.
2741* Generalised `pathSegmentEncoder`, added `pathFieldEncoder`.
2842* Added some `Prism`s to the encoder library for manipulating `DSum`s.
2943* Add `ob doc` command, which lists paths to haddock documentation for specified packages.