Skip to content

Would be good to have MIGRATION_GUIDE.md or similar #774

@vfonic

Description

@vfonic

I just saw that v10.0.0 of this gem has been released couple of days ago.

So I went to README.md and CHANGELOG.md to see what are the breaking changes before upgrading.
From reading both of these files, I have no idea what are the breaking changes.

There's required rails version bump, apart from that, I not sure I'm missing something else or not?

Here's how it looked like for v9 and I was glad to see this and more confident upgrading:
https://github.com/Shopify/shopify_app#upgrading-from-86-to-900

Edit: shopify_app v9 also got a clear(er) entry (regarding breaking changes) in CHANGELOG.md: https://github.com/Shopify/shopify_app/blob/master/CHANGELOG.md#900

Breaking change: Api version support added see migration guide

(migration guide pointing to the above-linked README.md "Upgrading from 8.6 to 9.0.0"

I think a MIGRATION_GUIDE.md would be great, or at least an entry in CHANGELOG.md which would clearly state what are the breaking changes. So in this version bump it would state something like:

Apart from minimum required rails version change, there are no other breaking changes.

Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions