Commit 1b29aaf2 authored by Lukas Riedel's avatar Lukas Riedel 📝

Release version 2.0.0

* Bump version numbers.
* Update default image versions in Dockerfiles.
* Improve MR and issue description templates for releases.
parent 7a3c6167
......@@ -11,6 +11,7 @@ variables:
BASE_IMAGE: dorie/dune-env
# Use semantic versioning (not the version of DUNE) and bump according to
# to whether changes are backwards-compatible or not.
# NOTE: Update the default value in the Dockerfiles accordingly!
IMAGE_VERSION: "1.3"
DUNE_ENV_IMAGE: ${BASE_IMAGE}:img-v${IMAGE_VERSION}
......
......@@ -4,14 +4,13 @@
We're rolling out version `X.Y.0`! :tada:
### 1 — In the Code
- [ ] `master`: Update version numbers in `VERSION`, `CHANGELOG.md`,
`dune.module` to `X.Y.0`.
- [ ] `master`: Update all `version="unreleased"` tags in the default config
file XML sources to `version="X.Y.0"`.
- [ ] `master`: Update all [version directives][sphinx-ver-dir] with version
`unreleased` in the user docs to `X.Y.0`.
- [ ] [Create branch][new branch] `X.Y-release` from `master`.
- [ ] *(Insert MR here)*: Merge `X.Y-release` into `master`. Use the
`pre-release` MR description template.
### 2 — On GitLab
- [ ] [Create branch][new branch] `X.Y-stable` from `master`
- [ ] [Create label][new label] ~"Pick into X.Y"
- [ ] [Create tag][new tag] `X.Y.0` from branch `X.Y-stable`
......@@ -31,14 +30,17 @@ We're rolling out version `X.Y.0`! :tada:
- [ ] Update "Release" [project badge][badge] <!-- only if applicable -->
### 3 — In the Code
- [ ] `master`: Update version numbers in `VERSION`, `CHANGELOG.md`,
`dune.module` to `X.Y+1-pre`.
- [ ] *(Insert MR here)*: Merge `X.Y-release` into `master`. Use the
`post-release` description template.
### 4 — On Docker Hub
- [ ] Update [description on DockerHub][DockerHub description]
- [ ] Push new `latest` tag to DockerHub <!-- only if applicable -->
### 5 — All done? :white_check_mark:
Close this issue!
/label ~Release
......@@ -49,4 +51,3 @@ Close this issue!
[new label]: https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/-/labels/new
[DockerHub description]: https://hub.docker.com/r/dorie/dorie
[badge]: https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/edit
[sphinx-ver-dir]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionadded
<!-- _Set the title to: "Post Release: X.Y.0" -->
<!-- Replace X.Y with the actual version numbers everywhere -->
We're updating the repository after Release `X.Y.0` 🧹
### Release Issue
<!-- DO NOT use automatic Issue resolution here! -->
The release is coordinated in issue #
### Tasks
- [ ] Update version numbers in `VERSION`, `CHANGELOG.md`, `dune.module` to
`X.Y+1-pre`.
### Can this MR be merged?
- [ ] Pipeline passing <!-- please check for new warnings -->
- [ ] Delete branch option set
### Related Issues
<!-- _Set the title to: "Pre Release: X.Y.0" -->
<!-- Replace X.Y.0 with the actual version numbers everywhere -->
We're gearing up for Release `X.Y.0` 🎉
### Release Issue
<!-- DO NOT use automatic Issue resolution here! -->
The release is coordinated in issue #
### Tasks
- [ ] Update version numbers in `VERSION`, `CHANGELOG.md`, `dune.module` to
`X.Y.0`.
- [ ] Update all `version="unreleased"` tags in the default config file XML
sources to `version="X.Y.0"`.
- [ ] Update all [version directives][sphinx-ver-dir] with version `unreleased`
in the user docs to `X.Y.0`.
- [ ] Trigger re-build of Docker base image,
see [`docker/README.md`][docker_readme]
### Can this MR be merged?
- [ ] Pipeline passing <!-- please check for new warnings -->
- [ ] Delete branch option **not set**
### Related Issues
[docker_readme]: https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/blob/master/docker/README.md
[sphinx-ver-dir]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionadded
# DORiE Changelog
## Unreleased
## 2.0.0 (2020-05-14)
### Added
......
1.2.0-pre
\ No newline at end of file
2.0.0
......@@ -27,7 +27,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<suggestion> richards </suggestion>
<values> richards, richards+transport </values>
<comment> Options: richards, richards+transport </comment>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
</category>
......@@ -86,7 +86,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<values> path </values>
<suggestion> None </suggestion>
<comment> This category is only used for 'rectangular' grids </comment>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="volume">
......@@ -96,7 +96,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<suggestion> 0 </suggestion>
<values> path or int </values>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="boundaryLower">
......@@ -106,7 +106,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<suggestion> 0 </suggestion>
<values> path or int </values>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="boundaryUpper">
......@@ -116,7 +116,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<suggestion> 1 </suggestion>
<values> path or int </values>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="boundaryLeft">
......@@ -126,7 +126,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<suggestion> 2 </suggestion>
<values> path or int </values>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="boundaryRight">
......@@ -136,7 +136,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<suggestion> 3 </suggestion>
<values> path or int </values>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="boundaryFront">
......@@ -147,7 +147,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<suggestion> 4 </suggestion>
<values> path or int </values>
<comment> Only in 3D </comment>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="boundaryBack">
......@@ -157,7 +157,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<suggestion> 5 </suggestion>
<values> path or int </values>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
</category>
......@@ -170,7 +170,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<values> none, waterFlux </values>
<suggestion> none </suggestion>
<comment> Options: none, waterFlux </comment>
<versionadded version="unreleased"> Replaces ``useAdaptivity``.
<versionadded version="2.0.0"> Replaces ``useAdaptivity``.
</versionadded>
</parameter>
......@@ -214,7 +214,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<values> elementFraction, errorFraction, threshold </values>
<suggestion> elementFraction </suggestion>
<comment> Options: elementFraction, errorFraction, threshold </comment>
<versionchanged version="unreleased"> Option ``targetTolerance`` removed.
<versionchanged version="2.0.0"> Option ``targetTolerance`` removed.
</versionchanged>
</parameter>
......@@ -247,7 +247,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<comment> Options: trace, debug, info, warning, error, critical
</comment>
</parameter>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</category>
<category name="misc">
......
......@@ -29,7 +29,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
The dataset name inside the ``outputFile``.
</definition>
<values> path </values>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="converter">
......@@ -41,7 +41,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<values> none, binary, exponential </values>
<suggestion> binary </suggestion>
<comment> Options: none, binary, exponential </comment>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="tempDir">
......@@ -51,7 +51,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<values> path </values>
<suggestion> /tmp/fft_generator/ </suggestion>
<versionchanged version="unreleased"> Renamed from
<versionchanged version="2.0.0"> Renamed from
``generator.fft.outputPath``. </versionchanged>
</parameter>
</category>
......@@ -61,7 +61,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<definition> Physical dimensions of the field. </definition>
<suggestion> 2 </suggestion>
<values> 2, 3 </values>
<versionchanged version="unreleased"> Renamed from
<versionchanged version="2.0.0"> Renamed from
``generator.dimensions``. </versionchanged>
</parameter>
......@@ -72,7 +72,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<values> int &times; int (&times; int) </values>
<suggestion> 1 1 </suggestion>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="cells">
......@@ -80,7 +80,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<values> int &times; int (&times; int) </values>
<suggestion> 100 100 </suggestion>
<versionchanged version="unreleased"> Renamed from ``generator.fft.N``.
<versionchanged version="2.0.0"> Renamed from ``generator.fft.N``.
</versionchanged>
</parameter>
</category>
......@@ -94,7 +94,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<values> int </values>
<suggestion> 1 </suggestion>
<versionchanged version="unreleased"> Renamed from
<versionchanged version="2.0.0"> Renamed from
``generator.fft.seed``. </versionchanged>
</parameter>
......@@ -104,7 +104,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<values> float </values>
<suggestion> 0.2 </suggestion>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="corrLength">
......@@ -113,7 +113,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<values> float &times; float (&times; float) </values>
<suggestion> .1 .05 </suggestion>
<versionchanged version="unreleased"> Renamed from
<versionchanged version="2.0.0"> Renamed from
``generator.fft.correlationLenghts``. </versionchanged>
</parameter>
......@@ -124,7 +124,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<suggestion> gaussian </suggestion>
<comment> Options: exponential, gaussian, spherical, whiteNoise
</comment>
<versionchanged version="unreleased"> Renamed from
<versionchanged version="2.0.0"> Renamed from
``generator.fft.covariance``. </versionchanged>
</parameter>
</category>
......@@ -137,7 +137,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<values> int </values>
<suggestion> 0 1 </suggestion>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
</category>
......@@ -151,7 +151,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<values> bool </values>
<suggestion> true </suggestion>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
</category>
</dorie>
......@@ -20,7 +20,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<definition> Logging level of the Richards solver. </definition>
<suggestion> info </suggestion>
<values> trace, debug, info, warning, error, critical </values>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="outputPath">
......@@ -53,7 +53,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<suggestion> endOfRichardsStep </suggestion>
<values> endOfRichardsStep, none </values>
<comment> Options: endOfRichardsStep, none </comment>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="subsamplingLevel">
......@@ -84,7 +84,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<values> path </values>
<suggestion> richards_bc.yml </suggestion>
<versionchanged version="unreleased"> Expects a YAML file now.
<versionchanged version="2.0.0"> Expects a YAML file now.
</versionchanged>
</parameter>
</category>
......@@ -99,7 +99,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<suggestion> analytic </suggestion>
<comment> Options: data, analytic, stationary
</comment>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="quantity">
......@@ -109,14 +109,14 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<values> matricHead, waterContent </values>
<suggestion> matricHead </suggestion>
<comment> Choose quantity represented: matricHead, waterContent </comment>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="equation">
<definition> Equation for the initial condition </definition>
<values> equation [x,y,z,h] </values>
<suggestion> -h </suggestion>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="file">
......@@ -125,14 +125,14 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
file extension ``.h5``.
</definition>
<values> path </values>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="dataset">
<definition> Dataset to use as initial condition (``data`` type only).
</definition>
<values> string </values>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="interpolation">
......@@ -140,7 +140,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<values> nearest, linear </values>
<suggestion> linear </suggestion>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
</category>
......@@ -215,7 +215,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<values> path </values>
<suggestion> richards_param.yml </suggestion>
</parameter>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</category>
<category name="numerics">
......@@ -227,7 +227,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<suggestion> 1 </suggestion>
<values> 0, 1, 2, 3 </values>
<comment> Select '0' for the finite volume (FV) solver </comment>
<versionchanged version="unreleased"> Renamed from ``grid.FEorder``.
<versionchanged version="2.0.0"> Renamed from ``grid.FEorder``.
</versionchanged>
</parameter>
......@@ -245,7 +245,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<comment> Options (recommended for):
none (DG), semiUpwind (DG), fullUpwind (FV)
</comment>
<versionchanged version="unreleased"> Renamed from
<versionchanged version="2.0.0"> Renamed from
``dg.experimental.upwinding``. </versionchanged>
</parameter>
......@@ -263,7 +263,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<values> SIPG, NIPG, OBB, IIP </values>
<comment> Options: SIPG, NIPG, OBB, IIP </comment>
<suggestion> SIPG </suggestion>
<versionchanged version="unreleased"> Renamed from
<versionchanged version="2.0.0"> Renamed from
``dg.experimental.method``. </versionchanged>
</parameter>
......@@ -273,7 +273,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<values> true, false </values>
<suggestion> true </suggestion>
<versionchanged version="unreleased"> Renamed from
<versionchanged version="2.0.0"> Renamed from
``dg.experimental.weights``. </versionchanged>
</parameter>
......@@ -282,7 +282,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<values> float </values>
<suggestion> 10 </suggestion>
<versionchanged version="unreleased"> Renamed from
<versionchanged version="2.0.0"> Renamed from
``dg.penaltyFactor``. </versionchanged>
</parameter>
</category>
......@@ -296,7 +296,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<suggestion> true </suggestion>
<values> true, false </values>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="checkJumps">
......@@ -308,7 +308,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
<suggestion> none </suggestion>
<values> none, warn, error </values>
<comment> Options: none, warn, error </comment>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
<parameter name="checkTol">
......@@ -317,7 +317,7 @@ A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
</definition>
<values> float &gt; 0 </values>
<suggestion> 1E-10 </suggestion>
<versionadded version="unreleased"> </versionadded>
<versionadded version="2.0.0"> </versionadded>
</parameter>
</category>
......
......@@ -66,10 +66,10 @@ Main Routine
Depending on the ``simulation.mode``, the respective model categories will be
read. The parameters without model prefix are always evaluated.
.. versionadded:: unreleased
.. versionadded:: 2.0.0
Added ``transport`` model parameters.
.. versionchanged:: unreleased
.. versionchanged:: 2.0.0
Split parameters into default and ``richards`` model parameters.
.. include:: @CHEATSHEET_DORIE_RELPATH@
ARG BASE_IMG_VERSION=1.2
ARG BASE_IMG_VERSION=1.3
ARG DUNE_ENV_IMAGE=dorie/dune-env:img-v${BASE_IMG_VERSION}
# start build image
......
ARG DUNE_ENV_IMAGE=dorie/dune-env
ARG BASE_IMG_VERSION=1.3
ARG DUNE_ENV_IMAGE=dorie/dune-env:img-v${BASE_IMG_VERSION}
FROM $DUNE_ENV_IMAGE
LABEL maintainer="lriedel@iup.uni-heidelberg.de"
# number of cores for parallel builds
ARG PROCNUM=1
# Compilers to be used
......@@ -12,4 +15,4 @@ WORKDIR /opt/dune
RUN ./dune-common/bin/dunecontrol update
RUN MAKE_FLAGS="-j ${PROCNUM}" \
CMAKE_FLAGS="-DCMAKE_BUILD_TYPE=Release -DCMAKE_C_COMPILER=${CC} -DCMAKE_CXX_COMPILER=${CXX} -DDUNE_PYTHON_VIRTUALENV_SETUP=True -DDUNE_PYTHON_ALLOW_GET_PIP=True" \
./dune-common/bin/dunecontrol all
\ No newline at end of file
./dune-common/bin/dunecontrol all
......@@ -4,8 +4,8 @@
#Name of the module
Module: dorie
Version: 1.2.0-pre
Version: 2.0.0
Maintainer: dorieteam@iup.uni-heidelberg.de
#depending on
Depends: dune-pdelab dune-uggrid dune-randomfield
Suggests: dune-testtools
\ No newline at end of file
Suggests: dune-testtools
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment