Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v2.0.0 #167

Merged
merged 14 commits into from
Feb 12, 2024
Merged

Release v2.0.0 #167

merged 14 commits into from
Feb 12, 2024

Conversation

BenjaminRodenberg
Copy link
Member

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.

BenjaminRodenberg and others added 10 commits July 4, 2023 14:57
* Update citation cff
* Update ReleaseGuide.md
* Refer to preCICE Literature guide
* Let the games begin :)

* should still fail?

* lets try again with a bit more logic

* seperate dockerfile concerns in pythonbinding_ref and adapter ref

* adopt to pythonbindings

---------

Co-authored-by: Valentin Seitz <[email protected]>
Co-authored-by: Ishaan Desai <[email protected]>
Link is again broken. Decided to remove it after just fixing it via #157
* Remove API functions that are removed in v3.0.0. Fix data initialization.
* Forward dt to python bindings.
* Set mesh connectivity information only if it is required. Closes #138
* Update tests
* Update links of contributors
* Update CHANGELOG.md
* Call checkpointing functions from the interface
* Change required version of pyprecice to >=3.0.0.0
* Comment out nearest projection volume coupling.

---------

Co-authored-by: Ishaan Desai <[email protected]>
@BenjaminRodenberg BenjaminRodenberg added compatibility breaking change Breaking change that should only be included in a major release labels Feb 12, 2024
@BenjaminRodenberg BenjaminRodenberg added this to the v2.0.0 milestone Feb 12, 2024
@BenjaminRodenberg BenjaminRodenberg self-assigned this Feb 12, 2024
Copy link
Member

@IshaanDesai IshaanDesai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍 I did not test any cases specifically, but the CI checks should be sufficient. pyprecice version used should be v3.0.0.0.

@uekerman
Copy link
Member

uekerman commented Feb 12, 2024

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: precice/openfoam-adapter#319 (comment)

@IshaanDesai
Copy link
Member

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
Copy link
Member Author

@uekerman for the FEniCS adapter we have to do a breaking release, if we want to support preCICE v3. See #153 and how the API of the adapter changes. We also had to updates all the tutorials. See precice/tutorials@63273dd.

@BenjaminRodenberg BenjaminRodenberg merged commit 8b76fe2 into master Feb 12, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change Breaking change that should only be included in a major release compatibility
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants