Plan for next release - v2.0
Opened this issue ยท 32 comments
Opening this to think about/plan for the next release, which I propose should encompass:
Plus these changes merged since:
Plus these target changes:
- Removing python 3.7 support and adding python 3.12: #2453
- Removing Flask-BabelEx support and moving back to using Flask-Babel: #2460
- Flask
host_matching
support: #2461 - Allow configuring FLASK_ADMIN_SWATCH per admin instance: #2462
- Standardise app.config names: #2472
- SQLAlchemy 2 compatibility (@cjmayo): #2483
- Flask 3 compatibility (@cjmayo)
- WTForms 3 compatibility (@cjmayo)
- Remove bs2 and bs3: #2474
- More clearly define our dependencies/versions: #2476
- Customise and prevent arbitrary user-overrides of
page_size
: #2479 - Support CSP: #2480
- #2481
- Remove any existing
DeprecationWarning
s - Switch from boto to boto3 for S3FileAdmin: #2552
- Update azure-storage-blob from v3 to v12+
And potentially any other small PRs we think we can get in fairly easily.
When the changeset is locked
- review and update documentation for anything that's been missed
- write a changelog entry: https://github.com/pallets-eco/flask-admin/pull/2499/files
Because of those last target changes, we'd need to do this as a major version bump.
@aenglander @Abdur-rahmaanJ - thoughts?
@samuelhwilliams How about 1.7?
What makes you suggest 1.7?
I think standard practice would be to assume Semantic Versioning, which says breaking changes should be a major versioning bump (ie 1 to 2). Dropping python 3.7 and dropping flask-babelex are breaking changes, so I think V2 would be the logical step to me.
Happy to hear counter arguments though.
Good then did not see any breaking changes from the description. Good ๐ for a 2.0.
I believe #2407 is suitable for the next release.
Flask-Babel and host_matching PRs are up. Will leave open for feedback for a few days.
Aiming to do a 2.0.0rc0 release next week ish.
Right. We have a bunch of stuff merged - I'm thinking of doing a 2.0.0rc0 release, maybe tomorrow. That would mean (in my head) no more feature merges - only bug fix merges - until 2.0.0 proper is released.
Do we think we want to try to get anything else simple/quick in urgently before the rc0 release?
@cjmayo Have added SQLAlchemy 2/Flask 3/WTForms 3 as target changes for a 2.0.0 release, if you're happy with that? I'm happy to try to help where needed, although it looks like maybe you've got it covered.
There are more configuration changes too, like when creating Admin
instance, so I guess it is fair to think about the next release tagging with 2.0.0
@cjmayo Have added SQLAlchemy 2/Flask 3/WTForms 3 as target changes for a 2.0.0 release, if you're happy with that? I'm happy to try to help where needed, although it looks like maybe you've got it covered.
I'm happy. I think I have enough - at least to get the tests to pass (I have been using these patches for a while with the new dependencies).
Would you like to weigh in/mind weighing in on #2476? It deals with dependencies too, specifically making it more explicit what dependencies are required for certain features and what versions we support. It doesn't do much work bumping dependencies, but should make it easier to test+validate dep bumps in the future.
Ok - the target date is obviously slipping a bit, but I think it's useful to get a few more of these things in before doing some kind of pre-release.
Notably:
Can we have in the docs a suggested approach for considering client's timezone when submitting datetime fields? I am referring to #1892
@ElLorans would you like to put up a PR adding some information and/or an example? I think specifically an example would be super helpful :)
@samuelhwilliams just opened #2502
Since the changes merged so far for v2.0.0 include a lot of dependency bumps, I think it also makes sense to switch the S3 admin interface over from using boto
to boto3
, and the azure-blob-storage
interface to using azure-storage-blob>=12. So will try to include those as well.
Thank you for all the hard work on the new release. I noticed that while there are many exciting updates mentioned, there hasn't been any discussion about the state of translations. There was an earlier issue (#1950) that raised concerns about updating translations, and I was wondering if this has been addressed in the latest release or if there are any plans to do so.
Hey @pajusmar - it's a good question. I've asked it on the pallets-eco discord to work out what our plan is with translations... ๐
Going to publish v2.0.0a0 shortly - this is an pre-release so would be grateful to anyone able to test it out and see what bugs there may be ๐
It's not feature-complete yet necessarily, and I still think it'd be nice to get updates to fileadmin for AWS and Azure in, but I just haven't had time yet. Anyone able to contribute those changes (essentially migrating fileadmin.s3 to use boto3, and updating fileadmin.azure to use azure-storage-blob>=12)
v2.0.0a0 is now published
Hey @pajusmar - it's a good question. I've asked it on the pallets-eco discord to work out what our plan is with translations... ๐
@samuelhwilliams, I saw on Discord that I should submit a pull request to modify translations.
I would really like to change one word. "Add" is a verb, not a noun, as it's currently translated into Estonian. The correct translation is "Lisa". Will it make it to 2.0, or are we past the string freeze?
Nope, by all means put up a PR please. Changes now would still go into V2.0.0 :)
Out of curiosity โ is there any progress on #1974? (Or at least any information about its causes?)
It just seems kind of bizarre that "View record" & "Edit record" button tooltips are translated, but "Delete record" is not ๐
Out of curiosity โ is there any progress on #1974? (Or at least any information about its causes?)
It just seems kind of bizarre that "View record" & "Edit record" button tooltips are translated, but "Delete record" is not ๐
Yes that's annoying for sure
Out of curiosity โ is there any progress on #1974? (Or at least any information about its causes?)
It just seems kind of bizarre that "View record" & "Edit record" button tooltips are translated, but "Delete record" is not ๐
This is fixed in #2526 (comment) . @samuelhwilliams can we release 2.0? Are there still DeprecationWarnings?
I will (try to) do a 2.0.0a1 soon. I think there's probably still more stuff that makes sense to do for a 'proper' v2 release - updating both of the fileadmin implementations for a start.
I've done a v2.0.0a1 now that includes those changes and compatibility support for wtforms v3.2+
I do still think it would be good to get in updates for s3/ABS before doing an official release of v2.0.0, but I also am aware that it's taking quite a chunk of time for me to have time for that and there's maybe not a huge amount of appetite from anyone else to add it. :(
Possibly also good to drop python 3.8 and add python 3.13, too.
Ok I found time to do boto->boto3, so just azure blob storage to go really ๐ค
that's now available as v2.0.0a2
@samuelhwilliams Is there an issue about azure blob storage? I can probably tackle that. Just wondering if there were known issues about upgrading, or just general SDK interface changes.
I'm not aware of any issues specifically - but that is mostly because I haven't looked closely yet. It may well just be SDK interface changes. Would be very grateful if you wanted to tackle it, it's really the last big blocker for an official v2 release, I think ๐
If there isn't an obvious issue open, please feel free to open one to track it ๐
PR for Azure storage upgrade: https://github.com/pallets-eco/flask-admin/pull/2573/files