Hotfix v3.3.1

[fsimonis]

How to work with this template

• assign a release manager, who takes care of the process
• assign each point below to a responsible person, before you continue. Use @member.

Only the release manager should update this post (even tickboxes, due to race conditions in editing). Everybody else should comment on the PR with the progress.

Pre-PR steps

• Make sure you have the latest main branch locally.
• Create branch hotfix-vX.Y.Z from main. If needed, git rebase main.
• Commit fixes to the hotfix branch
• Check code base w.r.t code formatting (run pre-commit run -va)
• Update the list of operating systems for the package generation in .github/workflows/release.yml
• Run tools/releasing/bumpversion.sh MAJOR.MINOR.PATCH to bump the version
• Look over the updated CHANGELOG.md of the hotfix branch (all)
  • Check for merged lines
  • Add things, if necessary
  • Fix wording and tense
  • Sort the entries lexicographically
  • Extract summary
• Verify the version changes in:
  • CHANGELOG
  • CMakeLists.txt
  • tools/releasing/packaging/debian/changelog
• Commit the version bump
• Push the hotfix branch to the precice repository

Step by step guide

• Open PR from hotfix-vX.Y.Z to main (use this template)
• Trigger the system tests using the trigger-system-tests label (release_test suite). After any force-push, remove and add the label again.
• Fix potential problems on the hotfix branch (all)
• Reorder the commits for the version bump to be the latest. git rebase -i main
• Draft release notes
• Write a draft "blog post" on Discourse
• Approve the PR with at least two reviews (all)
• Merge PR to main ( use git merge --no-ff hotfix-vX.Y.Z )
• Tag hotfix on main vX.Y.Z and verify by running git describe --tags
• Merge main back to develop and verify by running git describe --tags
• Triple check that you haven't messed anything up. You can always discard local changes using git reset --hard upstream BRANCH or by cloning the precice repository again and start from scratch.
• Push main and the vX.Y.Z tag: git push upstream main, git push upstream v3.3.1
• Push develop: git push upstream develop
• Wait for the release pipeline
  • To create a new draft hotfix on GitHub
  • To automatically generate packages for the latest Debian and the two latest Ubuntu LTS versions.
• Write hotfix text
• Publish the GitHub hotfix

Post-release

• Update version specific documentation
• Flag Arch Linux AUR package and dependants as out-of-date.
• Update Spack recipe
• Update Website:
  • Bump version in _config.yml
  • Update the XML reference using binprecice md
  • Look over the Roadmap and update entries.

Marketing

• Finalize post on Discourse
• Write on Matrix
• CFD Online:
  • News
  • Forum
• NADigest
• NAFEMS (needs account, appears in Upcoming Industry Events)
• Post on Bluesky
• Post on Mastodon
• Post in LinkedIn. Relevant places:
  • preCICE company
  • OpenFOAM group
  • HPC group
  • Personal

See the advertising a workshop section for additional ideas.

Misc

• Update the PR template

To open a new PR with this template, use this PR template query

[fsimonis]

MinGW UCRT Debug fails for the same reason we disabled it on develop.

Apart from that, the hotfix is ready for review.

[MakisH]

MinGW UCRT Debug fails for the same reason we disabled it on develop.

If this is known to fail and it is anyway something that is not a regression (but something we want to support as well at some point), does it make sense disabling it in this release? Otherwise, the main branch will (still) look broken, which is rather misleading.

[fsimonis]

Otherwise, the main branch will (still) look broken, which is rather misleading.

True. I cherry-picked it to the hotfix.

[fsimonis]

I re-triggered the systemtest and will wait for @IshaanDesai to approve as he requires the hotfix.

[IshaanDesai]

I ran a two-scale simulation with the Micro Manager and the hotfix, and can confirm that nested events work as expected.

[MakisH]

Website: versions bumped in:

• general: Bump preCICE version to v3.3.1 precice.github.io#682
• quickstart: Bump preCICE and OpenFOAM versions in Quickstart tutorials#690

Not a time to update the Roadmap (bugfix release, and the Roadmap needs more discussion anyway).

[MakisH]

Posted on Mastodon and Bluesky. @fsimonis posted on Matrix.

I don't think we need to post anywhere else for this release.