Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a migration guide #345

Closed
bheisler opened this issue Feb 1, 2020 · 2 comments
Closed

Add a migration guide #345

bheisler opened this issue Feb 1, 2020 · 2 comments
Labels
docs Missing examples, tutorials, guides, typos, ..

Comments

@bheisler
Copy link

bheisler commented Feb 1, 2020

I've just updated my app from Seed 0.4.1 to 0.5.1, and it could have gone more smoothly. When I do breaking change releases of Criterion.rs I try to write a migration guide listing the breaking changes and what users will need to do to update their code for each change - I think it would be helpful if Seed did the same.

In particular, the problems I ran into:

  • Moving from futures 0.1 to std:future required a bunch of changes to the types returned by functions that make requests. Eventually I realized that it was actually simple to fix - I just needed to replace Future<Item = (.*), Error = (.*)> with Future<Output = Result<$1, $2>>.
  • Removed the init function in exchange for this before_mount/after_mount thing that I still don't really understand? There also doesn't seem to be any documentation about that.
  • Renamed map_message to map_msg. It took me a while to even realize that it had simply been renamed rather than removed entirely.
@David-OConnor
Copy link
Member

Good point - we'll add this to the readme before publishing 0.6.0

@MartinKavik
Copy link
Member

MartinKavik commented Feb 1, 2020

Moving from futures 0.1 to std:future required a bunch of changes to the types returned by functions that make requests.

  • Yeah, it's the example use-case for migration guide.

Removed the init function in exchange for this before_mount/after_mount

Renamed map_message to map_msg. It took me a while to even realize that it had simply been renamed rather than removed entirely.

  • I see it in the 0.5.1 changelog, so it shouldn't be a problem, but I agree that it should be also in suggested migration guide.

@MartinKavik MartinKavik added the docs Missing examples, tutorials, guides, typos, .. label Mar 9, 2020
@flosse flosse closed this as completed Mar 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Missing examples, tutorials, guides, typos, ..
Projects
None yet
Development

No branches or pull requests

4 participants