Adding the note about upgrades and env.py #517
Conversation
|
I think it is going to have to be more involved to properly document this. First of all, providing a link to an issue in the documentation is not appropriate. Imagine the documentation as being a self-contained book. I'm sure there are exceptions, but in general I do not like putting links to issues, stack overflow, etc. In my view it is the other way around, lesser platforms link to the documentation as the absolute truth. Second, in general the env.py file is fine and does not need to be upgraded when you upgrade Flask-Migrate. You have been the victim of an unusual event, the upgrade to SQLAlchemy 2.0, which is fairly major and required important changes in the env.py template. Outside of these types of rare events, an old env.py should work just fine with a new Flask-Migrate and Alembic. Related to the above is that many people customize their env.py, so for them copying the new version is not an option. If they are force to upgrade, then they must merge whatever they have changed into the new env.py. Lastly, there is also an alembic.ini file that is generated in the repository, and could potentially need an update. So I need to think about how to reflect all this in the documentation. |
As discussed in #514 .