From e79d71a7b7a266eb46323cbbf93f766856b7b817 Mon Sep 17 00:00:00 2001 From: veenstrajelmer <60435591+veenstrajelmer@users.noreply.github.com> Date: Fri, 18 Oct 2024 15:01:15 +0200 Subject: [PATCH 1/3] Release 030 (#197) * added dev release * bump version minor * added dev dependencies --- docs/dev_guide/intro.rst | 1 + docs/dev_guide/release.rst | 26 ++++++++++++++++++++++++++ hydromt_delft3dfm/__init__.py | 2 +- pyproject.toml | 3 +++ 4 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 docs/dev_guide/release.rst diff --git a/docs/dev_guide/intro.rst b/docs/dev_guide/intro.rst index 68f4968d..0283d335 100644 --- 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 dev_install.rst contributors.rst + release.rst diff --git a/docs/dev_guide/release.rst b/docs/dev_guide/release.rst new file mode 100644 index 00000000..ab53db50 --- /dev/null +++ b/docs/dev_guide/release.rst @@ -0,0 +1,26 @@ +.. _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: + +* Small pull request +* 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 index 6f8855ec..12fc5dc1 100644 --- 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.0" DATADIR = join(dirname(abspath(__file__)), "data") from .dflowfm import * diff --git a/pyproject.toml b/pyproject.toml index 7013cc52..1ffdfea3 100644 --- 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", From 78d5b940f73fe79a4d60d1126cfe6440144a373d Mon Sep 17 00:00:00 2001 From: veenstrajelmer Date: Fri, 18 Oct 2024 15:02:32 +0200 Subject: [PATCH 2/3] updated changelog --- docs/changelog.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 1c4220c2..76c9f64e 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -6,7 +6,7 @@ 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 +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. From 429c5690c92ce88d478917d8ad07fe46f015f4d0 Mon Sep 17 00:00:00 2001 From: veenstrajelmer Date: Fri, 18 Oct 2024 15:11:18 +0200 Subject: [PATCH 3/3] post-release --- docs/changelog.rst | 12 ++++++++++++ docs/dev_guide/release.rst | 1 - hydromt_delft3dfm/__init__.py | 2 +- 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 76c9f64e..da364fb3 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -6,6 +6,18 @@ 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 +========== + +Added +----- + +Changed +------- + +Fixed +----- + v0.3.0 (18 October 2024) ========== This version includes many code updates to accomodate for newer versions of dependencies. diff --git a/docs/dev_guide/release.rst b/docs/dev_guide/release.rst index ab53db50..fedd4143 100644 --- a/docs/dev_guide/release.rst +++ b/docs/dev_guide/release.rst @@ -20,7 +20,6 @@ Release steps: Post release: -* Small pull request * 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 index 12fc5dc1..3894d0b5 100644 --- a/hydromt_delft3dfm/__init__.py +++ b/hydromt_delft3dfm/__init__.py @@ -2,7 +2,7 @@ from os.path import abspath, dirname, join -__version__ = "0.3.0" +__version__ = "0.3.1" DATADIR = join(dirname(abspath(__file__)), "data") from .dflowfm import *