Deltares / imod-qgis

🗺️🧭 QGIS plugin for iMOD
GNU General Public License v2.0
7 stars 1 forks source link

Supported versions: too opaque #24

Closed Huite closed 11 months ago

Huite commented 2 years ago

The installation guide (https://deltares.github.io/iMOD-Documentation/viewer_install.html) mentions:

You can download the standalone QGIS setup on the QGIS website We recommend downloading a QGIS version > 3.18 here

There are at least two problems with this:

Secondly, we should make a plan for whether we'll stick to the latest changes or not. If we do stick to latest changes, we need to assign versions carefully to the plugin. My personal preference is to stick to LTR if possible. But this is something we might be able to test: if new versions of QGIS do not constantly break the plugin, we could stick to latest changes.

On the upside, I think the notice has been removed that the Mesh stuff may be changed without notice? https://qgis.org/pyqgis/master/core/QgsMeshDataset.html

Second, we need a careful changelog detailing which changes in QGIS necessitate changes in the plugin.

JoerivanEngelen commented 2 years ago

FYI: The warning about API changes for meshes is still present on some pages, e.g.: https://qgis.org/pyqgis/master/core/QgsMeshLayer.html So I'm not sure...

JoerivanEngelen commented 11 months ago

I've done done to clear things up:

The increase to 3.28 was necessary because we added the IDF widget, which apparently used functionality in the API not present in 3.18. So far, after a 1.5 years, experience is that the the API has been quite stable. A changelog is included in the metadata.txt, where we could add changes made because of changes in QGIS.

Right now, we're running some tests on QGIS 3.30. We could make this the latest version to quickly see if API changes break anything. For this to work better, the test bench needs to be expanded though.

Closing this as it seems less relevant given the stability of the QGIS API the last years. We can re-open this if the situation worsens.