precice / fenics-adapter

preCICE-adapter for the open source computing platform FEniCS
GNU Lesser General Public License v3.0
29 stars 15 forks source link

Release v2.0.0 #167

Closed BenjaminRodenberg closed 7 months ago

BenjaminRodenberg commented 7 months ago

This is mainly a compatibility release for the major preCICE release v3.0.0 https://github.com/precice/precice/releases/tag/v3.0.0. This especially breaks compatibility of the FEniCS adapter with older preCICE versions and is therefore considered as a major release of the FEniCS adapter.

The remaining changes are mainly minor bugfixes and documentation updates.

uekerman commented 7 months ago

This especially breaks compatibility of the FEniCS adapter with older preCICE versions and is therefore considered as a major release of the FEniCS adapter.

Normally, this is no reason for a major release. In the end, preCICE is only a dependency.

Similar discussion for the OpenFOAM adapter: https://github.com/precice/openfoam-adapter/pull/319#issuecomment-1934353464

IshaanDesai commented 7 months ago

Normally, this is no reason for a major release. In the end, preCICE is only a dependency.

But a FEniCS user calls the adapter API in their code, so their code will break when we release. This is fundamentally different than how the OpenFOAM adapter is used. Does this not warrant a major release?

BenjaminRodenberg commented 7 months ago

@uekerman for the FEniCS adapter we have to do a breaking release, if we want to support preCICE v3. See https://github.com/precice/fenics-adapter/pull/153 and how the API of the adapter changes. We also had to updates all the tutorials. See https://github.com/precice/tutorials/commit/63273dd86ce2bf5ee5df50bc7ebb8e3e5310c1a7.