Release 3.8
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:
-
Call a meeting -
Assign developers to the major subtasks - Manager: @IvBu
- Lecture: @RoWin
- Doxygen: @melaniel, @IvBu - !3654 (merged), !3658 (merged)
- Course: @mathis
- Examples: @DennisGlaeser
- Website: @timok
-
Create a group (dumux-repositories) milestone in GitLab -
Fix planned [Dune] and compiler compatibility -
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:
-
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:
Hard Feature Freeze!
-
Check remaining MRs and Issues -
Update the milestone issue -
Generate example documentation with the script generate_example_docs.py -
Update CHANGELOG -
Announce hard feature freeze on the mailing list -
Header check (run make headercheck
) -
Re-generate parameter list ( bin/doc/generate_parameterlist.py
) and check log file (maybe manual updates tobin/doc/docextra/parameters.json
are needed) -
Make sure the CMakeLists.txt in dumux
subfolder are up-to-date (generated withbin/create_cmakelists.py
, dumuxmake install
should result in a usable installed dumux version) -
Create release branches -
Configure CI to test release branch -
Local Testing (different compilers and dependency setups)
During the week of the release:
Final testing!
-
Re-run tests -
Update copyright -
Update License -
Test Lecture and Course -
Update Website -
Create a release candidate -
Call for testing
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 DaRUS citation Include the DaRUS citation to the website (only major releases)
After the release
-
Bump version in dune.module to next version (!3690 (merged)) -
Write a release email to dumux@listserv.uni-stuttgart.de about updates on supported features and upcoming changes
Open issues and merge requests
-
#1180 (closed) - !2986 (merged) !3044!3572 (merged) (new compositional staggered) -
#1173 (closed) - (remove scv/scvf.geometry() interface) -
#1156 - (FluxVariables is a misnomer)moved to 3.9 -
#1303 (moved) - (gitLab Latex equation rendering in dumux-course) -
#1302 (closed) - (avoid name clashes in config.h.cmake) -
#1299 (closed) - !3617 (merged) !3618 (merged) !3648 (merged) (exclude simultaneous use of periodic and manual checkpoints) -
#1301 - !3627 (merged) !3647 (merged) (adaptive time step reduction)moved to 3.9 -
dumux lecture #29 - (make dumux-lecture reuse compliant) -
#1213 - (metadata collection)moved to 3.9 -
#1197 - (generic author and contributor list for DuMuX)moved to 3.9 -
!3654 (merged) - !3657 (closed) !3658 (merged) (verify doxygen log file exists) -
!3645 (closed) - (draft for grid geometry docu)discontinued for now
Edited by Ivan Buntic