Merge branch 'main' into support-for-hydromt-v1

Deltares · Oct 18, 2024 · a2d9e00 · a2d9e00
2 parents 0631e3b + 429c569
commit a2d9e00
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 2 deletions.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -6,7 +6,19 @@ All notable changes to this project will be documented in this page.
 The format is based on `Keep a Changelog`_, and this project adheres to
 `Semantic Versioning`_.
 
-Unreleased
+UNRELEASED
+==========
+
+Added
+-----
+
+Changed
+-------
+
+Fixed
+-----
+
+v0.3.0 (18 October 2024)
 ==========
 This version includes many code updates to accomodate for newer versions of dependencies.
 The only upper bound left is hydromt<1.

diff --git a/docs/dev_guide/intro.rst b/docs/dev_guide/intro.rst
@@ -13,3 +13,4 @@ Furthermore it informs you on planned developments and new features.
    Developer's guide <https://deltares.github.io/hydromt/latest/dev/contributing>
    dev_install.rst
    contributors.rst
+   release.rst
diff --git a/docs/dev_guide/release.rst b/docs/dev_guide/release.rst
@@ -0,0 +1,25 @@
+.. _dev_release:
+
+Releasing
+=========
+
+Release steps:
+
+* Change version in __init__.py
+* update the changelog
+* Check dependencies in pyproj.toml
+* run local testbank
+* local check with: ``flit build`` and ``twine check dist/*``
+* create PR and merge back to main
+* create a new release: https://github.com/Deltares/hydromt_delft3dfm/releases/new)
+* click ``choose a tag`` and type v+versionnumber (e.g. ``v0.1.0``), click ``create new tag: v0.1.0 on publish``
+* set the release title to the tagname (e.g. ``v0.1.0``)
+* click `Generate release notes` and replace the `What's Changed` info by a tagged link to ``docs/whats-new.md``
+* if all is set, click ``Publish release``
+* a release is created and the github action publishes it [on PyPI](https://pypi.org/project/dfm-tools)
+
+Post release:
+
+* Update the version to 0.1.1 (bump patch)
+* Initialise changelog unrelease/added/fixed/changed
+* Push and merge to main
diff --git a/hydromt_delft3dfm/__init__.py b/hydromt_delft3dfm/__init__.py
@@ -2,7 +2,7 @@
 
 from os.path import abspath, dirname, join
 
-__version__ = "0.2.1.dev"
+__version__ = "0.3.1"
 DATADIR = join(dirname(abspath(__file__)), "data")
 
 from .dflowfm import *
diff --git a/pyproject.toml b/pyproject.toml
@@ -49,6 +49,9 @@ dev = [
     "ruff",        # linting
     "pre-commit",  # linting
     "pip>=23.1.2", # needed for recursive dependencies
+    "flit>3.4",    # build
+    "twine",       # build
+    "wheel",       # build
 ]
 test = [
     "pytest>=2.7.3",