Release 3.5
This a release issue template with a checklist based on Release Manager Tasks. Check there for details on each task.
[5 Weeks] prior to the release: (30 Mar 22)
-
Call a meeting -
Assign developers to the major subtasks - Manager: @yue
- Lecture Larry: @stefaniekiemle
- Doxygen Dude: @melaniel #1131 (closed)
- Handbook Handsome: @IvBu
- Course Coolness: @heck
- Examples Exceller: @ackerm
- Website Wizard: @RoWin
- Testing/Coverage Turtle: @IvBu
-
Create a group (dumux-repositories) milestone in GitLab -
Fix planned [Dune] and compiler compatibility (Dune 2.8/2.9-git, C++17 gcc9.3/clang10, CMake 3.13, Python 3.6) -
Go through all existing Gitlab tasks ([issues] or [MRs]) -
Assign the open [issues] and [MRs] to the developers -
Post a release schedule announcement on the mailing list
[3 weeks] prior to the release: (13 Apr 22)
Soft Feature Freeze!
-
Check all open MRs and Issues for severity and impact -
Update the milestone issue -
Announce soft feature freeze on the mailing list -
Check in with the managers of the sub-tasks
[2 weeks] prior to the release: (20 Apr 22)
Hard Feature Freeze!
-
Check remaining MRs and Issues: #1145 (closed), #1041 (closed), #966 (closed), #1101 (closed), dumux-lecture#27 (closed), dumux-website#45 (closed), dumux-testing#2, !3056 (merged), !3064 (merged), !3065 (closed), !2986 (merged) (?), dumux-website!100, dumux-testing!7, dumux-coverage!35, dumux-lecture!172 (merged), dumux-docker-ci!9 -
Update the milestone issue -
Update CHANGELOG (!3073 (merged), !3074 (merged)) -
Announce hard feature freeze on the mailing list -
Header check (run make headercheck
) (!3064 (merged), !3075 (merged)) -
Headercheck in dumux-lecture (dumux-lecture!174 (merged)) -
Generate example documentation with the script generate_example_docs.py
(already up to date) -
Check and update the runtime parameters (see bin/doc/getparameterlist.py
) !3067 (merged) -
Make sure the CMakeLists.txt in dumux
subfolder are up-to-date (generated withbin/utils/create_cmakelists.py
(!3065 (closed), !3066 (merged)) -
dumux make install
should result in a useable installed dumux version) (!3086 (merged), dumux-test-installation!1 (merged)) -
Create release branches -
Update all install scripts and the install text in the handbook (!3082 (merged), !3084 (merged)) -
Configure CI to test release branch -
Local Testing (different compilers and dependency setups) -
Make sure there is no compiler warning in both local and CI setup (also lecture and course) !3103 (merged) dumux-course!124 (merged), dumux-lecture!176 (merged)
During the week of the release: (27 Apr 22, Dumux coding day)
Final testing!
-
Re-run tests -
Update copyright (no changes) -
Update License (!3088 (merged), !3089 (merged)) -
Test Lecture and Course -
Update Website (dumux-website!100) -
Create a release candidate -
Call for testing
4 May 22 2 June 22)
Releasing DuMux: (Important: These steps are normally done together with Bernd. Make sure to schedule the time properly.
-
Protect release branch (in GitLab) -
Create new tags -
Prepare a Zenodo citation
MayJune 22)
After the release (-
Bump version in dune.module to next version -
Sent an E-Mail to the dumux mailing list about updates on supported features and upcoming changes -
Change CI schedule for release/3.5 to run only weekly (until the release it will run daily)
Edited by Timo Koch