|
|
# Release Manager Tasks
|
|
|
|
|
|
__Authors__: C. Grüninger (2.1), T. Fetzer (2.3), A. Kissinger (2.4), K. Weishaupt (2.9), J. Hommel (2.10), S. Ackermann (2.11), K. Heck (3.1), E. Coltman (3.2), K. Weishaupt (3.3)
|
|
|
__Authors__: C. Grüninger (2.1), T. Fetzer (2.3), A. Kissinger (2.4), K. Weishaupt (2.9), J. Hommel (2.10), S. Ackermann (2.11), K. Heck (3.1), E. Coltman (3.2), K. Weishaupt (3.3), H. Wu (3.4)
|
|
|
|
|
|
Most Recent Release: [DuMu<sup>x</sup> 3.3](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/tags/3.3.0) , 2020-11-13
|
|
|
Most Recent Release: [DuMu<sup>x</sup> 3.4](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/tags/3.4.0) , 2021-08-03
|
|
|
|
|
|
## Introduction
|
|
|
|
... | ... | @@ -15,7 +15,7 @@ some examples of old announcement emails. |
|
|
__Please update this document during your reign as release manager! Move all outdated material to the appendix.__
|
|
|
|
|
|
## [5 Weeks] prior to the release:
|
|
|
* __Call a meeting__: Contact all of the primary [DuMu<sup>x</sup>] 3.3 developers (LH2 employees) and organize a meeting. If possible, line this up with a dumuxDay. The following tasks should all be done and addressed during this meeting.
|
|
|
* __Call a meeting__: Contact all of the primary [DuMu<sup>x</sup>] developers (LH2 employees) and organize a meeting. If possible, line this up with a DuMu<sup>x</sup> Day. The following tasks should all be done and addressed during this meeting.
|
|
|
<br/>
|
|
|
|
|
|
* __Assign developers to the major subtasks__:
|
... | ... | @@ -28,7 +28,7 @@ __Please update this document during your reign as release manager! Move all out |
|
|
<br/>
|
|
|
|
|
|
* __Create a group (dumux-repositories) milestone in GitLab:__
|
|
|
- As this release relates to multiple git projects ([DuMu<sup>x</sup>], [DuMu<sup>x</sup>-Lecture], [DuMu<sup>x</sup>-Course]), mark the release milestone in the \dumux-repositories group. As an example, here are the milestones for [DuMu<sup>x</sup> 3.3](https://git.iws.uni-stuttgart.de/groups/dumux-repositories/-/milestones/4), [DuMu<sup>x</sup> 3.2](https://git.iws.uni-stuttgart.de/groups/dumux-repositories/-/milestones/2). and [DuMu<sup>x</sup> 3.1](https://git.iws.uni-stuttgart.de/groups/dumux-repositories/-/milestones/3). Within this milestone, list the dates for the feature freezes, the testing, and the release, as well as the people responsible for the major subtasks (See \ref{major_subtasks}: handbook, doxygen, website...).
|
|
|
- As this release relates to multiple git projects ([DuMu<sup>x</sup>], [DuMu<sup>x</sup>-Lecture], [DuMu<sup>x</sup>-Course]), mark the release milestone in the \dumux-repositories group. As an example, here are the milestones for [DuMu<sup>x</sup> 3.4](https://git.iws.uni-stuttgart.de/groups/dumux-repositories/-/milestones/5), [DuMu<sup>x</sup> 3.3](https://git.iws.uni-stuttgart.de/groups/dumux-repositories/-/milestones/4). and [DuMu<sup>x</sup> 3.2](https://git.iws.uni-stuttgart.de/groups/dumux-repositories/-/milestones/2). Within this milestone, list the dates for the feature freezes, the testing, and the release, as well as the people responsible for the major subtasks (See \ref{major_subtasks}: handbook, doxygen, website...).
|
|
|
<br/>
|
|
|
|
|
|
* __Fix planned [Dune] and compiler compatibility:__
|
... | ... | @@ -75,7 +75,7 @@ the last release (assumed to have taken place 2019-10-11) by |
|
|
git log --since="2019-10-11" or by
|
|
|
git log TAG...HEAD
|
|
|
```
|
|
|
where `TAG` is the tag of the last release (e.g. releases/3.1)
|
|
|
where `TAG` is the tag of the last release (e.g. `3.4.0`)
|
|
|
|
|
|
* __Announce Freeze:__ Announce hard feature freeze. Explain how no further changes to the code,
|
|
|
except for bugfixes and documentation will be accepted. See email examples [here](#example-emails).
|
... | ... | @@ -109,11 +109,11 @@ in the DuMu<sup>x</sup> -stable top folder. Use what the script recommends to ad |
|
|
* __Run create cmakelists__: Run the `bin/util/create cmakelists.py` script in `dumux/dumux`, in order
|
|
|
to update the cmakelists in the source directory.
|
|
|
|
|
|
* __Release Branches: For each DuMu<sup>x</sup> module, create a new branch titled releases/X.Y.__ (e.g., [DuMu<sup>x</sup> 3.3](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/tree/releases/3.3), [DuMu<sup>x</sup>-Lecture 3.3](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-lecture/-/tree/releases/3.3), [DuMu<sup>x</sup>-Course 3.3](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-course/-/tree/releases/3.3)
|
|
|
* __Release Branches: For each DuMu<sup>x</sup> module, create a new branch titled releases/X.Y.__ (e.g., [DuMu<sup>x</sup> 3.4](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/tree/releases/3.4), [DuMu<sup>x</sup>-Lecture 3.4](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-lecture/-/tree/releases/3.4), [DuMu<sup>x</sup>-Course 3.4](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-course/-/tree/releases/3.4)
|
|
|
|
|
|
-Create new branch: `git checkout -b releases/X.Y`
|
|
|
|
|
|
- Modify the versions required in dune.module (for example ”Version: 3.1-git” to ”Version: 3.2-
|
|
|
- Modify the versions required in dune.module (for example ”Version: 3.4-git” to ”Version: 3.5-
|
|
|
git”) and commit the change. Push the branch:
|
|
|
`git push origin releases/X.Y`
|
|
|
__From then on__, changes are still to be made to the master, but the merge commits should be
|
... | ... | @@ -154,14 +154,14 @@ in the DuMu<sup>x</sup> root directory. |
|
|
* __License:__ Complete the information of the copyright holders in the file [LICENSE.md](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/blob/master/LICENSE.md). To see who has contributed since the last release, you can execute
|
|
|
|
|
|
```
|
|
|
./bin/doc/getcontributors.sh -from 3.3.0 -to HEAD.
|
|
|
./bin/doc/getcontributors.sh -from 3.4.0 -to HEAD.
|
|
|
```
|
|
|
|
|
|
in the dumux repository directory, replacing 3.3.0 by the version of the last release or its commit sha. Alternatively, you may use the graphical overview on [graph](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/network/master), where you
|
|
|
in the dumux repository directory, replacing 3.4.0 by the version of the last release or its commit sha. Alternatively, you may use the graphical overview on [graph](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/network/master), where you
|
|
|
can specify the period of interest using the mouse on the top graph. Be sure to include those who
|
|
|
have contributed to DuMu<sup>x</sup> outside of the main repository (lecture, website, and course).
|
|
|
|
|
|
* __Lecture and Course:__ Test or let someone else test DuMu<sup>x</sup>-lecture and DuMu<sup>x</sup>-course. If they build and pass without errors or warnings, mark DuMu<sup>x</sup>-lecture/courses’ current git branch as compatible to the DuMu<sup>x</sup> version your release. This is done by adding a tag (modify the version X.Y): Go to the [gitlab tag section](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-lecture/tags) and click on `+New Tag`. Here, you have to assign the tag name (e.g. 3.2.0) and enter the release branch you tested for compatibility with the current release.
|
|
|
* __Lecture and Course:__ Test or let someone else test DuMu<sup>x</sup>-lecture and DuMu<sup>x</sup>-course. If they build and pass without errors or warnings, mark DuMu<sup>x</sup>-lecture/courses’ current git branch as compatible to the DuMu<sup>x</sup> version your release. This is done by adding a tag (modify the version X.Y): Go to the [gitlab tag section](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-lecture/tags) and click on `+New Tag`. Here, you have to assign the tag name (e.g. 3.5.0) and enter the release branch you tested for compatibility with the current release.
|
|
|
|
|
|
* __Website:__
|
|
|
-Update the make handbook script. Look at commit a87e55d2793edeb8fdfe0c1115520d509f3d6775 for an example.
|
... | ... | @@ -171,8 +171,8 @@ have contributed to DuMu<sup>x</sup> outside of the main repository (lecture, we |
|
|
- Update any changes to the installation guidelines.
|
|
|
|
|
|
|
|
|
* __Create a release candidate:__ Go to the tags section in DuMu<sup>x</sup>. Click create a new tab and name it after the release, with a trailing -rc1 (3.2.0-rc1, ”3.2 release candidate 1”). This tag should be set on the most recent commit from the release branch. In the message section write something like: ”The
|
|
|
first release candidate for the upcoming 3.2.0 release is now available. You can checkout the 3.2.0-rc1
|
|
|
* __Create a release candidate:__ Go to the tags section in DuMu<sup>x</sup>. Click create a new tab and name it after the release, with a trailing -rc1 (3.5.0-rc1, ”3.5 release candidate 1”). This tag should be set on the most recent commit from the release branch. In the message section write something like: ”The
|
|
|
first release candidate for the upcoming 3.5.0 release is now available. You can checkout the 3.5.0-rc1
|
|
|
tag via Git”.
|
|
|
|
|
|
* __Call for testing:__
|
... | ... | @@ -192,8 +192,8 @@ modified via a merge request merged by a maintainer. |
|
|
|
|
|
* __Create new tags:__
|
|
|
- Go to the [gitlab tag section](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/tags)
|
|
|
- The release tags should have a tailing 0 (for example 3.2.0) for listing purposes.
|
|
|
- Click on `+New Tag`. Here, you have to assign the tag name (e.g. 3.2.0) and enter the commit-id
|
|
|
- The release tags should have a tailing 0 (for example 3.5.0) for listing purposes.
|
|
|
- Click on `+New Tag`. Here, you have to assign the tag name (e.g. 3.5.0) and enter the commit-id
|
|
|
of the last commit for the current release.
|
|
|
- Repeat the same procedure for dumux-lecture and the dumux-course
|
|
|
|
... | ... | @@ -316,4 +316,4 @@ __Past announcements of the DuMu<sup>x</sup> release__ |
|
|
[DuMu<sup>x</sup>-Lecture]: https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-lecture
|
|
|
[DuMu<sup>x</sup>-Course]: https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-course
|
|
|
[issues]: https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/issues
|
|
|
[MRs]: https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests |
|
|
\ No newline at end of file |
|
|
[MRs]: https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests |