Release v2.0.0 #319

davidscn · 2024-02-08T08:28:48Z

TODO list:

I updated the documentation in docs/
check for missing changelog entries

I don't know what to do with the foundation versions yet. With the changes and new features, it's noteworthy that the faceTriangulation/connectivity definition is different, the volume coupling changes seem incompatible, and also the handling of time/delta t is different (#298), which leads to many merge conflicts. Without some testing automation, following our typical rebase strategy runs into a lot of merge conflicts, which would require manual testing.

So, open question: which versions do we want to support in the upcoming release?

Based on the deprecation described in https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

WM_NCOMP_PROCS -> WM_NCOMPPROCS

* Allow overriding of the ADAPTER_PREP_FLAGS variable Currently the ADAPTER_PREP_FLAGS needs to be changed in the source code. This patch allows users to `export ADAPTER_PREP_FLAGS=` to alter the value of the variable through the environment without having to change the code. * Update docs/get.md --------- Co-authored-by: David Schneider <[email protected]>

Add a citation file

Update Actions set-output syntax

Co-authored-by: David Schneider <[email protected]>

* Fix iterator in FSI reader and writer for multiple patches * Add changelog entry

Related to precice/tutorials#337

* Skip pstream initialization for OpenFOAM < 2306 * Re-arrange 'if' logic for Pstream init

- as pointed out in #293

* Add simple script to create all the release archives * Rename variable * Update tools/create-release-archives.sh Co-authored-by: David Schneider <[email protected]> * Update tools/create-release-archives.sh Co-authored-by: David Schneider <[email protected]> * Apply suggestions from code review (trial 3) Co-authored-by: Gerasimos Chourdakis <[email protected]> --------- Co-authored-by: Gerasimos Chourdakis <[email protected]>

Co-authored-by: David Schneider <[email protected]> Co-authored-by: Frédéric Simonis <[email protected]>

Co-authored-by: ge72fah <[email protected]> Co-authored-by: Gerasimos Chourdakis <[email protected]>

* Change signature of write function to consider size_t * Implement return type for all CouplingDataUsers * Read relevant buffer part only * Indentation with clang-format 11

Co-authored-by: Gerasimos Chourdakis <[email protected]>

…308)

* Introduce tolerances for triggering warnings * Use 10^-14 instead of 12

Bumps [actions/cache](https://github.com/actions/cache) from 3 to 4. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](actions/cache@v3...v4) --- updated-dependencies: - dependency-name: actions/cache dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v2...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 2 to 4. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](actions/upload-artifact@v2...v4) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]>

uekerman · 2024-02-08T14:26:05Z

Why going for a breaking release? A breaking dependency is normally no sufficient reason. Maybe I am overlooking sth.

davidscn · 2024-02-08T14:53:23Z

Why going for a breaking release? A breaking dependency is normally no sufficient reason. Maybe I am overlooking sth.

Docs are here https://precice.org/adapter-openfoam-get.html#what-does-the-adapter-version-mean. Which version do you suggest?

MakisH · 2024-02-08T15:20:09Z

We have defined the configuration file format of the adapter (preciceDict) as the "stable API" of the adapter. Since we don't change that, this is still a v1.x. We discussed the "what would happen if we release a new preCICE major version" when creating the versioning system and we decided that it would not affect the adapter version. Definitely not a perfect system, but the explicit "preciceDict is what we need to keep stable" helps as a guideline.

New features are, for example, the volume coupling (#255) and the extensions to the fluid-fluid module (#281, #308).

For these reasons, I propose v1.3.0.
We should still clearly mention the preCICE v3 requirements in the release notes.

If we decide to indeed not have v2, then I would actually suggest to also rename the branch, to avoid confusion in the future.

I don't know what to do with the foundation versions yet.

So, open question: which versions do we want to support in the upcoming release?

I would not attempt to make our releases dependent on supporting new Foundation versions. We release our adapter when we are ready, and we can always release more ports to other OpenFOAM versions.

There are still a few things I would like to check before releasing, I will approve after that, but not before next week.

MakisH and others added 30 commits January 31, 2023 10:43

Document minimum version required for OpenFOAM v2212

b1e78cf

Fix documentation linting

efbe339

Update Actions set-output syntax

e4a5306

Based on the deprecation described in https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

Fix echo termination

f594d65

Document FFTW linking issues in Troubleshooting

365f01d

Documentation: Fix linter

b490b8d

Fix comment about WM_NCOMPPROCS in Allwmake

62142fd

WM_NCOMP_PROCS -> WM_NCOMPPROCS

Add a citation file

97b9f72

Fix indentation

bc819fa

Experiment with textregistered

852cda2

Remove preferred citation for experimental purpose

c2f66de

Use preferred citation with template version

3cbb4dd

Use correct authors

7a8c7e7

Revert changes

c6e5704

...

dc48737

fill correct info

1dc293f

Merge pull request #284 from precice/citation

93f84fb

Add a citation file

Merge pull request #280 from precice/update-ci-set-output

12d5bad

Update Actions set-output syntax

Add citing guidelines in README and docs (#287)

b0c383e

Co-authored-by: David Schneider <[email protected]>

Fix iterator in FSI reader and writer for multiple patches (#289)

846affd

* Fix iterator in FSI reader and writer for multiple patches * Add changelog entry

Markdown-lint: Disable MD034 (#290)

f91e204

Add note in docs regarding OpenFOAM9 residualControl name

25f9798

Related to precice/tutorials#337

Re-arrange if logic for Pstream initialization (#293)

98e448f

* Skip pstream initialization for OpenFOAM < 2306 * Re-arrange 'if' logic for Pstream init

Rectify version specifications for OPENFOAM and OPENFOAM_PLUS

69f4fd2

- as pointed out in #293

Merge branch 'master' into develop

0dbbc7a

Bump version from v1.2.3 to v1.2.3 + unreleased changes

e00bfcd

Bump default OpenFOAM version to v2306 (#296)

a2362f3

Merge initializeData into initialize (#262)

d573d0d

MakisH and others added 22 commits August 4, 2023 16:25

Add changelog entry

dc6d864

Update documentation

dfb2f63

Convert NULL to nullptr

9e41eef

Mesh connectivity for preCICE v3 (#297)

a8f1945

Co-authored-by: David Schneider <[email protected]> Co-authored-by: Frédéric Simonis <[email protected]>

Switch CI to build preCICE from develop (#299)

68f3bba

Add volume coupling feature (#255)

cc95bec

Co-authored-by: ge72fah <[email protected]> Co-authored-by: Gerasimos Chourdakis <[email protected]>

Update README.md

3e660e1

Updates to the FF module (#281)

389934a

Fix typo in DEBUG log of FF coupling

b0f4d1f

Reduce build targets to save building time (#301)

61e7f69

Pass the correct number of entries to writeData (#305)

c396868

* Change signature of write function to consider size_t * Implement return type for all CouplingDataUsers * Read relevant buffer part only * Indentation with clang-format 11

Re arrange read time according to adjustable dt (#298)

99421f7

Co-authored-by: Gerasimos Chourdakis <[email protected]>

Update hint to performance metric files

a0e5263

Add phase variable and flux coupling for interFOAM in the FF module (#…

1ed787a

…308)

Fix connectivity definition in the adapter (#315)

8db7f75

Introduce tolerances for triggering dt related warnings (#312)

fa6f48f

* Introduce tolerances for triggering warnings * Use 10^-14 instead of 12

Update release_pull_request_template.md for Spack

b831b5c

Configure dependabot for version updates

5206e0d

Bump version and update changelog

1cbe5a5

davidscn requested a review from MakisH February 8, 2024 08:28

MakisH marked this pull request as draft February 8, 2024 15:20

davidscn closed this Feb 8, 2024

davidscn deleted the release-v2.0.0 branch February 8, 2024 15:28

uekerman mentioned this pull request Feb 12, 2024

Release v2.0.0 precice/fenics-adapter#167

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release v2.0.0 #319

Release v2.0.0 #319

davidscn commented Feb 8, 2024

uekerman commented Feb 8, 2024

davidscn commented Feb 8, 2024

MakisH commented Feb 8, 2024

Release v2.0.0 #319

Release v2.0.0 #319

Conversation

davidscn commented Feb 8, 2024

uekerman commented Feb 8, 2024

davidscn commented Feb 8, 2024

MakisH commented Feb 8, 2024