Release.md 2.51 KB
Newer Older
1
2
3
4
5
6
<!--
This form is for release issue ONLY!
If you're looking for help check out the [readme](/README.md).
-->
This a release issue template with a checklist based on [Release Manager Tasks](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/wikis/Release-Manager-Tasks). Check there for details on each task.
# [5 Weeks] prior to the release:
7
8
- [ ]  Call a meeting
- [ ]  Assign developers to the major subtasks
9
10
11
12
13
14
15
    - Manager:
    - Lecture:
    - Doxygen:
    - Handbook:
    - Course:
    - Examples:
    - Website:
16
17
18
19
20
- [ ]  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
21
22

# [3 weeks] prior to the release:
23
24
25
26
- [ ]  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
27
28
29

# [2 weeks] prior to the release:
__Hard Feature Freeze!__
30
31
32
33
34
35
36
37
38
39
40
- [ ]  Check remaining MRs and Issues
- [ ]  Update the milestone issue
- [ ]  Update CHANGELOG
- [ ]  Announce hard feature freeze on the mailing list
- [ ]  Update all install scripts and the install text in the handbook
- [ ]  Header check (run `make headercheck`)
- [ ]  Check and update the runtime parameters (see `bin/doc/getparameterlist.py`)
- [ ]  Make sure the CMakeLists.txt in `dumux` subfolder are up-to-date (generated with `bin/utils/create_cmakelists.py`, dumux `make install` should result in a useable installed dumux version)
- [ ]  Create release branches
- [ ]  Configure CI to test release branch
- [ ]  Local Testing (different compilers and dependency setups)
41
42
43

# During the week of the release:
__Final testing!__
44
45
46
47
48
49
50
- [ ]  Re-run tests
- [ ]  Update copyright
- [ ]  Update License
- [ ]  Test Lecture and Course
- [ ]  Update Website
- [ ]  Create a release candidate
- [ ]  Call for testing
51
52

# Releasing DuMu<sup>x</sup>
53
54
55
56
57
58
__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
- [ ]  Include the Zenodo citation to the website
- [ ]  Write a release email to dumux@listserv.uni-stuttgart.de
59
60

# After the release
61
62
- [ ]  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