10gen / realm-cli

MongoDB Realm CLI
Apache License 2.0
6 stars 23 forks source link

Can't find v1 -> v2 release notes, migration guide? #254

Open emragins opened 2 years ago

emragins commented 2 years ago

Hello,

I want to upgrade to the latest version but I don't want to deal with any breaking changes. I can't find anything that looks like release notes, a changelog, or a migration guide.

Can you please point me to this resource?

Thank you.

emragins commented 2 years ago

I've gone ahead and tried to upgrade since it seems like I need it to use the HTTP Endpoints functionality.

I've migrated my scripts for secrets (every single thing had a breaking change); and I'm stuck migrating my push -- how do I get it to behave the same as --strategy=replace-by-name?

makesitgo commented 2 years ago

Hey there...sounds like you're on the right trick! For some quick doc links:

We don't have a "migration guide" but there shouldn't be too many difficult changes. A few things to watch out for:

1) import and export are still supported commands, but they're aliased (and more commonly referred to as now) push and pull, respectively

2) strategy is no longer a supported param, the default (and only) behavior with the new CLI is replace-by-name

3) when in doubt, consult realm-cli <cmd> --help if you find yourself not able to figure out any other flag (there are also a few internal/undocumented flags that we capture in the README of this repo

4) I would also recommend you do a fresh pull ("fresh" being into a brand new, empty directory) of whatever app you plan to work with... we have updated the structure of configuration files that get exported for an app, so by doing this you can make sure you are working with our latest and greatest